deploy: f4924f3181c5e250f876423f66da34d30b443912
diff --git a/docs/main/.buildinfo b/docs/main/.buildinfo index d6ebb96..e0c9ca3 100644 --- a/docs/main/.buildinfo +++ b/docs/main/.buildinfo
@@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 86d4b171ba47c51d1a3d7f924e02560f +config: 84f977a1210cb9b07e4d40d87be69d37 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/main/_static/base-stemmer.js b/docs/main/_static/base-stemmer.js new file mode 100644 index 0000000..e6fa0c4 --- /dev/null +++ b/docs/main/_static/base-stemmer.js
@@ -0,0 +1,476 @@ +// @ts-check + +/**@constructor*/ +BaseStemmer = function() { + /** @protected */ + this.current = ''; + this.cursor = 0; + this.limit = 0; + this.limit_backward = 0; + this.bra = 0; + this.ket = 0; + + /** + * @param {string} value + */ + this.setCurrent = function(value) { + this.current = value; + this.cursor = 0; + this.limit = this.current.length; + this.limit_backward = 0; + this.bra = this.cursor; + this.ket = this.limit; + }; + + /** + * @return {string} + */ + this.getCurrent = function() { + return this.current; + }; + + /** + * @param {BaseStemmer} other + */ + this.copy_from = function(other) { + /** @protected */ + this.current = other.current; + this.cursor = other.cursor; + this.limit = other.limit; + this.limit_backward = other.limit_backward; + this.bra = other.bra; + this.ket = other.ket; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.in_grouping = function(s, min, max) { + /** @protected */ + if (this.cursor >= this.limit) return false; + var ch = this.current.charCodeAt(this.cursor); + if (ch > max || ch < min) return false; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return false; + this.cursor++; + return true; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_in_grouping = function(s, min, max) { + /** @protected */ + while (this.cursor < this.limit) { + var ch = this.current.charCodeAt(this.cursor); + if (ch > max || ch < min) + return true; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) + return true; + this.cursor++; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.in_grouping_b = function(s, min, max) { + /** @protected */ + if (this.cursor <= this.limit_backward) return false; + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch > max || ch < min) return false; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return false; + this.cursor--; + return true; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_in_grouping_b = function(s, min, max) { + /** @protected */ + while (this.cursor > this.limit_backward) { + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch > max || ch < min) return true; + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return true; + this.cursor--; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.out_grouping = function(s, min, max) { + /** @protected */ + if (this.cursor >= this.limit) return false; + var ch = this.current.charCodeAt(this.cursor); + if (ch > max || ch < min) { + this.cursor++; + return true; + } + ch -= min; + if ((s[ch >>> 3] & (0X1 << (ch & 0x7))) == 0) { + this.cursor++; + return true; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_out_grouping = function(s, min, max) { + /** @protected */ + while (this.cursor < this.limit) { + var ch = this.current.charCodeAt(this.cursor); + if (ch <= max && ch >= min) { + ch -= min; + if ((s[ch >>> 3] & (0X1 << (ch & 0x7))) != 0) { + return true; + } + } + this.cursor++; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.out_grouping_b = function(s, min, max) { + /** @protected */ + if (this.cursor <= this.limit_backward) return false; + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch > max || ch < min) { + this.cursor--; + return true; + } + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) { + this.cursor--; + return true; + } + return false; + }; + + /** + * @param {number[]} s + * @param {number} min + * @param {number} max + * @return {boolean} + */ + this.go_out_grouping_b = function(s, min, max) { + /** @protected */ + while (this.cursor > this.limit_backward) { + var ch = this.current.charCodeAt(this.cursor - 1); + if (ch <= max && ch >= min) { + ch -= min; + if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) != 0) { + return true; + } + } + this.cursor--; + } + return false; + }; + + /** + * @param {string} s + * @return {boolean} + */ + this.eq_s = function(s) + { + /** @protected */ + if (this.limit - this.cursor < s.length) return false; + if (this.current.slice(this.cursor, this.cursor + s.length) != s) + { + return false; + } + this.cursor += s.length; + return true; + }; + + /** + * @param {string} s + * @return {boolean} + */ + this.eq_s_b = function(s) + { + /** @protected */ + if (this.cursor - this.limit_backward < s.length) return false; + if (this.current.slice(this.cursor - s.length, this.cursor) != s) + { + return false; + } + this.cursor -= s.length; + return true; + }; + + /** + * @param {Among[]} v + * @return {number} + */ + this.find_among = function(v) + { + /** @protected */ + var i = 0; + var j = v.length; + + var c = this.cursor; + var l = this.limit; + + var common_i = 0; + var common_j = 0; + + var first_key_inspected = false; + + while (true) + { + var k = i + ((j - i) >>> 1); + var diff = 0; + var common = common_i < common_j ? common_i : common_j; // smaller + // w[0]: string, w[1]: substring_i, w[2]: result, w[3]: function (optional) + var w = v[k]; + var i2; + for (i2 = common; i2 < w[0].length; i2++) + { + if (c + common == l) + { + diff = -1; + break; + } + diff = this.current.charCodeAt(c + common) - w[0].charCodeAt(i2); + if (diff != 0) break; + common++; + } + if (diff < 0) + { + j = k; + common_j = common; + } + else + { + i = k; + common_i = common; + } + if (j - i <= 1) + { + if (i > 0) break; // v->s has been inspected + if (j == i) break; // only one item in v + + // - but now we need to go round once more to get + // v->s inspected. This looks messy, but is actually + // the optimal approach. + + if (first_key_inspected) break; + first_key_inspected = true; + } + } + do { + var w = v[i]; + if (common_i >= w[0].length) + { + this.cursor = c + w[0].length; + if (w.length < 4) return w[2]; + var res = w[3](this); + this.cursor = c + w[0].length; + if (res) return w[2]; + } + i = w[1]; + } while (i >= 0); + return 0; + }; + + // find_among_b is for backwards processing. Same comments apply + /** + * @param {Among[]} v + * @return {number} + */ + this.find_among_b = function(v) + { + /** @protected */ + var i = 0; + var j = v.length + + var c = this.cursor; + var lb = this.limit_backward; + + var common_i = 0; + var common_j = 0; + + var first_key_inspected = false; + + while (true) + { + var k = i + ((j - i) >> 1); + var diff = 0; + var common = common_i < common_j ? common_i : common_j; + var w = v[k]; + var i2; + for (i2 = w[0].length - 1 - common; i2 >= 0; i2--) + { + if (c - common == lb) + { + diff = -1; + break; + } + diff = this.current.charCodeAt(c - 1 - common) - w[0].charCodeAt(i2); + if (diff != 0) break; + common++; + } + if (diff < 0) + { + j = k; + common_j = common; + } + else + { + i = k; + common_i = common; + } + if (j - i <= 1) + { + if (i > 0) break; + if (j == i) break; + if (first_key_inspected) break; + first_key_inspected = true; + } + } + do { + var w = v[i]; + if (common_i >= w[0].length) + { + this.cursor = c - w[0].length; + if (w.length < 4) return w[2]; + var res = w[3](this); + this.cursor = c - w[0].length; + if (res) return w[2]; + } + i = w[1]; + } while (i >= 0); + return 0; + }; + + /* to replace chars between c_bra and c_ket in this.current by the + * chars in s. + */ + /** + * @param {number} c_bra + * @param {number} c_ket + * @param {string} s + * @return {number} + */ + this.replace_s = function(c_bra, c_ket, s) + { + /** @protected */ + var adjustment = s.length - (c_ket - c_bra); + this.current = this.current.slice(0, c_bra) + s + this.current.slice(c_ket); + this.limit += adjustment; + if (this.cursor >= c_ket) this.cursor += adjustment; + else if (this.cursor > c_bra) this.cursor = c_bra; + return adjustment; + }; + + /** + * @return {boolean} + */ + this.slice_check = function() + { + /** @protected */ + if (this.bra < 0 || + this.bra > this.ket || + this.ket > this.limit || + this.limit > this.current.length) + { + return false; + } + return true; + }; + + /** + * @param {number} c_bra + * @return {boolean} + */ + this.slice_from = function(s) + { + /** @protected */ + var result = false; + if (this.slice_check()) + { + this.replace_s(this.bra, this.ket, s); + result = true; + } + return result; + }; + + /** + * @return {boolean} + */ + this.slice_del = function() + { + /** @protected */ + return this.slice_from(""); + }; + + /** + * @param {number} c_bra + * @param {number} c_ket + * @param {string} s + */ + this.insert = function(c_bra, c_ket, s) + { + /** @protected */ + var adjustment = this.replace_s(c_bra, c_ket, s); + if (c_bra <= this.bra) this.bra += adjustment; + if (c_bra <= this.ket) this.ket += adjustment; + }; + + /** + * @return {string} + */ + this.slice_to = function() + { + /** @protected */ + var result = ''; + if (this.slice_check()) + { + result = this.current.slice(this.bra, this.ket); + } + return result; + }; + + /** + * @return {string} + */ + this.assign_to = function() + { + /** @protected */ + return this.current.slice(0, this.limit); + }; +};
diff --git a/docs/main/_static/basic.css b/docs/main/_static/basic.css index 7ebbd6d..4738b2e 100644 --- a/docs/main/_static/basic.css +++ b/docs/main/_static/basic.css
@@ -741,14 +741,6 @@ cursor: help; } -.translated { - background-color: rgba(207, 255, 207, 0.2) -} - -.untranslated { - background-color: rgba(255, 207, 207, 0.2) -} - /* -- code displays --------------------------------------------------------- */ pre {
diff --git a/docs/main/_static/css/theme.css b/docs/main/_static/css/theme.css index 0f14f10..a88467c 100644 --- a/docs/main/_static/css/theme.css +++ b/docs/main/_static/css/theme.css
@@ -1,4 +1,4 @@ html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search .wy-dropdown>aactive,.wy-side-nav-search .wy-dropdown>afocus,.wy-side-nav-search>a:hover,.wy-side-nav-search>aactive,.wy-side-nav-search>afocus{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon,.wy-side-nav-search>a.icon{display:block}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.switch-menus{position:relative;display:block;margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-side-nav-search>div.switch-menus>div.language-switch,.wy-side-nav-search>div.switch-menus>div.version-switch{display:inline-block;padding:.2em}.wy-side-nav-search>div.switch-menus>div.language-switch select,.wy-side-nav-search>div.switch-menus>div.version-switch select{display:inline-block;margin-right:-2rem;padding-right:2rem;max-width:240px;text-align-last:center;background:none;border:none;border-radius:0;box-shadow:none;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-size:1em;font-weight:400;color:hsla(0,0%,100%,.3);cursor:pointer;appearance:none;-webkit-appearance:none;-moz-appearance:none}.wy-side-nav-search>div.switch-menus>div.language-switch select:active,.wy-side-nav-search>div.switch-menus>div.language-switch select:focus,.wy-side-nav-search>div.switch-menus>div.language-switch select:hover,.wy-side-nav-search>div.switch-menus>div.version-switch select:active,.wy-side-nav-search>div.switch-menus>div.version-switch select:focus,.wy-side-nav-search>div.switch-menus>div.version-switch select:hover{background:hsla(0,0%,100%,.1);color:hsla(0,0%,100%,.5)}.wy-side-nav-search>div.switch-menus>div.language-switch select option,.wy-side-nav-search>div.switch-menus>div.version-switch select option{color:#000}.wy-side-nav-search>div.switch-menus>div.language-switch:has(>select):after,.wy-side-nav-search>div.switch-menus>div.version-switch:has(>select):after{display:inline-block;width:1.5em;height:100%;padding:.1em;content:"\f0d7";font-size:1em;line-height:1.2em;font-family:FontAwesome;text-align:center;pointer-events:none;box-sizing:border-box}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search .wy-dropdown>aactive,.wy-side-nav-search .wy-dropdown>afocus,.wy-side-nav-search>a:hover,.wy-side-nav-search>aactive,.wy-side-nav-search>afocus{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon,.wy-side-nav-search>a.icon{display:block}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.switch-menus{position:relative;display:block;margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-side-nav-search>div.switch-menus>div.language-switch,.wy-side-nav-search>div.switch-menus>div.version-switch{display:inline-block;padding:.2em}.wy-side-nav-search>div.switch-menus>div.language-switch select,.wy-side-nav-search>div.switch-menus>div.version-switch select{display:inline-block;margin-right:-2rem;padding-right:2rem;max-width:240px;text-align-last:center;background:none;border:none;border-radius:0;box-shadow:none;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-size:1em;font-weight:400;color:hsla(0,0%,100%,.3);cursor:pointer;appearance:none;-webkit-appearance:none;-moz-appearance:none}.wy-side-nav-search>div.switch-menus>div.language-switch select:active,.wy-side-nav-search>div.switch-menus>div.language-switch select:focus,.wy-side-nav-search>div.switch-menus>div.language-switch select:hover,.wy-side-nav-search>div.switch-menus>div.version-switch select:active,.wy-side-nav-search>div.switch-menus>div.version-switch select:focus,.wy-side-nav-search>div.switch-menus>div.version-switch select:hover{background:hsla(0,0%,100%,.1);color:hsla(0,0%,100%,.5)}.wy-side-nav-search>div.switch-menus>div.language-switch select option,.wy-side-nav-search>div.switch-menus>div.version-switch select option{color:#000}.wy-side-nav-search>div.switch-menus>div.language-switch:has(>select):after,.wy-side-nav-search>div.switch-menus>div.version-switch:has(>select):after{display:inline-block;width:1.5em;height:100%;padding:.1em;content:"\f0d7";font-size:1em;line-height:1.2em;font-family:FontAwesome;text-align:center;pointer-events:none;box-sizing:border-box}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%;float:none;margin-left:0}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file
diff --git a/docs/main/_static/doctools.js b/docs/main/_static/doctools.js index 0398ebb..807cdb1 100644 --- a/docs/main/_static/doctools.js +++ b/docs/main/_static/doctools.js
@@ -59,7 +59,7 @@ Object.assign(Documentation.TRANSLATIONS, catalog.messages); Documentation.PLURAL_EXPR = new Function( "n", - `return (${catalog.plural_expr})` + `return (${catalog.plural_expr})`, ); Documentation.LOCALE = catalog.locale; }, @@ -89,7 +89,7 @@ const togglerElements = document.querySelectorAll("img.toggler"); togglerElements.forEach((el) => - el.addEventListener("click", (event) => toggler(event.currentTarget)) + el.addEventListener("click", (event) => toggler(event.currentTarget)), ); togglerElements.forEach((el) => (el.style.display = "")); if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); @@ -98,14 +98,15 @@ initOnKeyListeners: () => { // only install a listener if it is really needed if ( - !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && - !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS + && !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS ) return; document.addEventListener("keydown", (event) => { // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) + return; // bail with special keys if (event.altKey || event.ctrlKey || event.metaKey) return;
diff --git a/docs/main/_static/english-stemmer.js b/docs/main/_static/english-stemmer.js new file mode 100644 index 0000000..056760e --- /dev/null +++ b/docs/main/_static/english-stemmer.js
@@ -0,0 +1,1066 @@ +// Generated from english.sbl by Snowball 3.0.1 - https://snowballstem.org/ + +/**@constructor*/ +var EnglishStemmer = function() { + var base = new BaseStemmer(); + + /** @const */ var a_0 = [ + ["arsen", -1, -1], + ["commun", -1, -1], + ["emerg", -1, -1], + ["gener", -1, -1], + ["later", -1, -1], + ["organ", -1, -1], + ["past", -1, -1], + ["univers", -1, -1] + ]; + + /** @const */ var a_1 = [ + ["'", -1, 1], + ["'s'", 0, 1], + ["'s", -1, 1] + ]; + + /** @const */ var a_2 = [ + ["ied", -1, 2], + ["s", -1, 3], + ["ies", 1, 2], + ["sses", 1, 1], + ["ss", 1, -1], + ["us", 1, -1] + ]; + + /** @const */ var a_3 = [ + ["succ", -1, 1], + ["proc", -1, 1], + ["exc", -1, 1] + ]; + + /** @const */ var a_4 = [ + ["even", -1, 2], + ["cann", -1, 2], + ["inn", -1, 2], + ["earr", -1, 2], + ["herr", -1, 2], + ["out", -1, 2], + ["y", -1, 1] + ]; + + /** @const */ var a_5 = [ + ["", -1, -1], + ["ed", 0, 2], + ["eed", 1, 1], + ["ing", 0, 3], + ["edly", 0, 2], + ["eedly", 4, 1], + ["ingly", 0, 2] + ]; + + /** @const */ var a_6 = [ + ["", -1, 3], + ["bb", 0, 2], + ["dd", 0, 2], + ["ff", 0, 2], + ["gg", 0, 2], + ["bl", 0, 1], + ["mm", 0, 2], + ["nn", 0, 2], + ["pp", 0, 2], + ["rr", 0, 2], + ["at", 0, 1], + ["tt", 0, 2], + ["iz", 0, 1] + ]; + + /** @const */ var a_7 = [ + ["anci", -1, 3], + ["enci", -1, 2], + ["ogi", -1, 14], + ["li", -1, 16], + ["bli", 3, 12], + ["abli", 4, 4], + ["alli", 3, 8], + ["fulli", 3, 9], + ["lessli", 3, 15], + ["ousli", 3, 10], + ["entli", 3, 5], + ["aliti", -1, 8], + ["biliti", -1, 12], + ["iviti", -1, 11], + ["tional", -1, 1], + ["ational", 14, 7], + ["alism", -1, 8], + ["ation", -1, 7], + ["ization", 17, 6], + ["izer", -1, 6], + ["ator", -1, 7], + ["iveness", -1, 11], + ["fulness", -1, 9], + ["ousness", -1, 10], + ["ogist", -1, 13] + ]; + + /** @const */ var a_8 = [ + ["icate", -1, 4], + ["ative", -1, 6], + ["alize", -1, 3], + ["iciti", -1, 4], + ["ical", -1, 4], + ["tional", -1, 1], + ["ational", 5, 2], + ["ful", -1, 5], + ["ness", -1, 5] + ]; + + /** @const */ var a_9 = [ + ["ic", -1, 1], + ["ance", -1, 1], + ["ence", -1, 1], + ["able", -1, 1], + ["ible", -1, 1], + ["ate", -1, 1], + ["ive", -1, 1], + ["ize", -1, 1], + ["iti", -1, 1], + ["al", -1, 1], + ["ism", -1, 1], + ["ion", -1, 2], + ["er", -1, 1], + ["ous", -1, 1], + ["ant", -1, 1], + ["ent", -1, 1], + ["ment", 15, 1], + ["ement", 16, 1] + ]; + + /** @const */ var a_10 = [ + ["e", -1, 1], + ["l", -1, 2] + ]; + + /** @const */ var a_11 = [ + ["andes", -1, -1], + ["atlas", -1, -1], + ["bias", -1, -1], + ["cosmos", -1, -1], + ["early", -1, 5], + ["gently", -1, 3], + ["howe", -1, -1], + ["idly", -1, 2], + ["news", -1, -1], + ["only", -1, 6], + ["singly", -1, 7], + ["skies", -1, 1], + ["sky", -1, -1], + ["ugly", -1, 4] + ]; + + /** @const */ var /** Array<int> */ g_aeo = [17, 64]; + + /** @const */ var /** Array<int> */ g_v = [17, 65, 16, 1]; + + /** @const */ var /** Array<int> */ g_v_WXY = [1, 17, 65, 208, 1]; + + /** @const */ var /** Array<int> */ g_valid_LI = [55, 141, 2]; + + var /** boolean */ B_Y_found = false; + var /** number */ I_p2 = 0; + var /** number */ I_p1 = 0; + + + /** @return {boolean} */ + function r_prelude() { + B_Y_found = false; + /** @const */ var /** number */ v_1 = base.cursor; + lab0: { + base.bra = base.cursor; + if (!(base.eq_s("'"))) + { + break lab0; + } + base.ket = base.cursor; + if (!base.slice_del()) + { + return false; + } + } + base.cursor = v_1; + /** @const */ var /** number */ v_2 = base.cursor; + lab1: { + base.bra = base.cursor; + if (!(base.eq_s("y"))) + { + break lab1; + } + base.ket = base.cursor; + if (!base.slice_from("Y")) + { + return false; + } + B_Y_found = true; + } + base.cursor = v_2; + /** @const */ var /** number */ v_3 = base.cursor; + lab2: { + while(true) + { + /** @const */ var /** number */ v_4 = base.cursor; + lab3: { + golab4: while(true) + { + /** @const */ var /** number */ v_5 = base.cursor; + lab5: { + if (!(base.in_grouping(g_v, 97, 121))) + { + break lab5; + } + base.bra = base.cursor; + if (!(base.eq_s("y"))) + { + break lab5; + } + base.ket = base.cursor; + base.cursor = v_5; + break golab4; + } + base.cursor = v_5; + if (base.cursor >= base.limit) + { + break lab3; + } + base.cursor++; + } + if (!base.slice_from("Y")) + { + return false; + } + B_Y_found = true; + continue; + } + base.cursor = v_4; + break; + } + } + base.cursor = v_3; + return true; + }; + + /** @return {boolean} */ + function r_mark_regions() { + I_p1 = base.limit; + I_p2 = base.limit; + /** @const */ var /** number */ v_1 = base.cursor; + lab0: { + lab1: { + /** @const */ var /** number */ v_2 = base.cursor; + lab2: { + if (base.find_among(a_0) == 0) + { + break lab2; + } + break lab1; + } + base.cursor = v_2; + if (!base.go_out_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + if (!base.go_in_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + } + I_p1 = base.cursor; + if (!base.go_out_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + if (!base.go_in_grouping(g_v, 97, 121)) + { + break lab0; + } + base.cursor++; + I_p2 = base.cursor; + } + base.cursor = v_1; + return true; + }; + + /** @return {boolean} */ + function r_shortv() { + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + if (!(base.out_grouping_b(g_v_WXY, 89, 121))) + { + break lab1; + } + if (!(base.in_grouping_b(g_v, 97, 121))) + { + break lab1; + } + if (!(base.out_grouping_b(g_v, 97, 121))) + { + break lab1; + } + break lab0; + } + base.cursor = base.limit - v_1; + lab2: { + if (!(base.out_grouping_b(g_v, 97, 121))) + { + break lab2; + } + if (!(base.in_grouping_b(g_v, 97, 121))) + { + break lab2; + } + if (base.cursor > base.limit_backward) + { + break lab2; + } + break lab0; + } + base.cursor = base.limit - v_1; + if (!(base.eq_s_b("past"))) + { + return false; + } + } + return true; + }; + + /** @return {boolean} */ + function r_R1() { + return I_p1 <= base.cursor; + }; + + /** @return {boolean} */ + function r_R2() { + return I_p2 <= base.cursor; + }; + + /** @return {boolean} */ + function r_Step_1a() { + var /** number */ among_var; + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab0: { + base.ket = base.cursor; + if (base.find_among_b(a_1) == 0) + { + base.cursor = base.limit - v_1; + break lab0; + } + base.bra = base.cursor; + if (!base.slice_del()) + { + return false; + } + } + base.ket = base.cursor; + among_var = base.find_among_b(a_2); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + switch (among_var) { + case 1: + if (!base.slice_from("ss")) + { + return false; + } + break; + case 2: + lab1: { + /** @const */ var /** number */ v_2 = base.limit - base.cursor; + lab2: { + { + /** @const */ var /** number */ c1 = base.cursor - 2; + if (c1 < base.limit_backward) + { + break lab2; + } + base.cursor = c1; + } + if (!base.slice_from("i")) + { + return false; + } + break lab1; + } + base.cursor = base.limit - v_2; + if (!base.slice_from("ie")) + { + return false; + } + } + break; + case 3: + if (base.cursor <= base.limit_backward) + { + return false; + } + base.cursor--; + if (!base.go_out_grouping_b(g_v, 97, 121)) + { + return false; + } + base.cursor--; + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_1b() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_5); + base.bra = base.cursor; + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + switch (among_var) { + case 1: + /** @const */ var /** number */ v_2 = base.limit - base.cursor; + lab2: { + lab3: { + /** @const */ var /** number */ v_3 = base.limit - base.cursor; + lab4: { + if (base.find_among_b(a_3) == 0) + { + break lab4; + } + if (base.cursor > base.limit_backward) + { + break lab4; + } + break lab3; + } + base.cursor = base.limit - v_3; + if (!r_R1()) + { + break lab2; + } + if (!base.slice_from("ee")) + { + return false; + } + } + } + base.cursor = base.limit - v_2; + break; + case 2: + break lab1; + case 3: + among_var = base.find_among_b(a_4); + if (among_var == 0) + { + break lab1; + } + switch (among_var) { + case 1: + /** @const */ var /** number */ v_4 = base.limit - base.cursor; + if (!(base.out_grouping_b(g_v, 97, 121))) + { + break lab1; + } + if (base.cursor > base.limit_backward) + { + break lab1; + } + base.cursor = base.limit - v_4; + base.bra = base.cursor; + if (!base.slice_from("ie")) + { + return false; + } + break; + case 2: + if (base.cursor > base.limit_backward) + { + break lab1; + } + break; + } + break; + } + break lab0; + } + base.cursor = base.limit - v_1; + /** @const */ var /** number */ v_5 = base.limit - base.cursor; + if (!base.go_out_grouping_b(g_v, 97, 121)) + { + return false; + } + base.cursor--; + base.cursor = base.limit - v_5; + if (!base.slice_del()) + { + return false; + } + base.ket = base.cursor; + base.bra = base.cursor; + /** @const */ var /** number */ v_6 = base.limit - base.cursor; + among_var = base.find_among_b(a_6); + switch (among_var) { + case 1: + if (!base.slice_from("e")) + { + return false; + } + return false; + case 2: + { + /** @const */ var /** number */ v_7 = base.limit - base.cursor; + lab5: { + if (!(base.in_grouping_b(g_aeo, 97, 111))) + { + break lab5; + } + if (base.cursor > base.limit_backward) + { + break lab5; + } + return false; + } + base.cursor = base.limit - v_7; + } + break; + case 3: + if (base.cursor != I_p1) + { + return false; + } + /** @const */ var /** number */ v_8 = base.limit - base.cursor; + if (!r_shortv()) + { + return false; + } + base.cursor = base.limit - v_8; + if (!base.slice_from("e")) + { + return false; + } + return false; + } + base.cursor = base.limit - v_6; + base.ket = base.cursor; + if (base.cursor <= base.limit_backward) + { + return false; + } + base.cursor--; + base.bra = base.cursor; + if (!base.slice_del()) + { + return false; + } + } + return true; + }; + + /** @return {boolean} */ + function r_Step_1c() { + base.ket = base.cursor; + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + if (!(base.eq_s_b("y"))) + { + break lab1; + } + break lab0; + } + base.cursor = base.limit - v_1; + if (!(base.eq_s_b("Y"))) + { + return false; + } + } + base.bra = base.cursor; + if (!(base.out_grouping_b(g_v, 97, 121))) + { + return false; + } + lab2: { + if (base.cursor > base.limit_backward) + { + break lab2; + } + return false; + } + if (!base.slice_from("i")) + { + return false; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_2() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_7); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + if (!r_R1()) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_from("tion")) + { + return false; + } + break; + case 2: + if (!base.slice_from("ence")) + { + return false; + } + break; + case 3: + if (!base.slice_from("ance")) + { + return false; + } + break; + case 4: + if (!base.slice_from("able")) + { + return false; + } + break; + case 5: + if (!base.slice_from("ent")) + { + return false; + } + break; + case 6: + if (!base.slice_from("ize")) + { + return false; + } + break; + case 7: + if (!base.slice_from("ate")) + { + return false; + } + break; + case 8: + if (!base.slice_from("al")) + { + return false; + } + break; + case 9: + if (!base.slice_from("ful")) + { + return false; + } + break; + case 10: + if (!base.slice_from("ous")) + { + return false; + } + break; + case 11: + if (!base.slice_from("ive")) + { + return false; + } + break; + case 12: + if (!base.slice_from("ble")) + { + return false; + } + break; + case 13: + if (!base.slice_from("og")) + { + return false; + } + break; + case 14: + if (!(base.eq_s_b("l"))) + { + return false; + } + if (!base.slice_from("og")) + { + return false; + } + break; + case 15: + if (!base.slice_from("less")) + { + return false; + } + break; + case 16: + if (!(base.in_grouping_b(g_valid_LI, 99, 116))) + { + return false; + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_3() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_8); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + if (!r_R1()) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_from("tion")) + { + return false; + } + break; + case 2: + if (!base.slice_from("ate")) + { + return false; + } + break; + case 3: + if (!base.slice_from("al")) + { + return false; + } + break; + case 4: + if (!base.slice_from("ic")) + { + return false; + } + break; + case 5: + if (!base.slice_del()) + { + return false; + } + break; + case 6: + if (!r_R2()) + { + return false; + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_4() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_9); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + if (!r_R2()) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_del()) + { + return false; + } + break; + case 2: + lab0: { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab1: { + if (!(base.eq_s_b("s"))) + { + break lab1; + } + break lab0; + } + base.cursor = base.limit - v_1; + if (!(base.eq_s_b("t"))) + { + return false; + } + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_Step_5() { + var /** number */ among_var; + base.ket = base.cursor; + among_var = base.find_among_b(a_10); + if (among_var == 0) + { + return false; + } + base.bra = base.cursor; + switch (among_var) { + case 1: + lab0: { + lab1: { + if (!r_R2()) + { + break lab1; + } + break lab0; + } + if (!r_R1()) + { + return false; + } + { + /** @const */ var /** number */ v_1 = base.limit - base.cursor; + lab2: { + if (!r_shortv()) + { + break lab2; + } + return false; + } + base.cursor = base.limit - v_1; + } + } + if (!base.slice_del()) + { + return false; + } + break; + case 2: + if (!r_R2()) + { + return false; + } + if (!(base.eq_s_b("l"))) + { + return false; + } + if (!base.slice_del()) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_exception1() { + var /** number */ among_var; + base.bra = base.cursor; + among_var = base.find_among(a_11); + if (among_var == 0) + { + return false; + } + base.ket = base.cursor; + if (base.cursor < base.limit) + { + return false; + } + switch (among_var) { + case 1: + if (!base.slice_from("sky")) + { + return false; + } + break; + case 2: + if (!base.slice_from("idl")) + { + return false; + } + break; + case 3: + if (!base.slice_from("gentl")) + { + return false; + } + break; + case 4: + if (!base.slice_from("ugli")) + { + return false; + } + break; + case 5: + if (!base.slice_from("earli")) + { + return false; + } + break; + case 6: + if (!base.slice_from("onli")) + { + return false; + } + break; + case 7: + if (!base.slice_from("singl")) + { + return false; + } + break; + } + return true; + }; + + /** @return {boolean} */ + function r_postlude() { + if (!B_Y_found) + { + return false; + } + while(true) + { + /** @const */ var /** number */ v_1 = base.cursor; + lab0: { + golab1: while(true) + { + /** @const */ var /** number */ v_2 = base.cursor; + lab2: { + base.bra = base.cursor; + if (!(base.eq_s("Y"))) + { + break lab2; + } + base.ket = base.cursor; + base.cursor = v_2; + break golab1; + } + base.cursor = v_2; + if (base.cursor >= base.limit) + { + break lab0; + } + base.cursor++; + } + if (!base.slice_from("y")) + { + return false; + } + continue; + } + base.cursor = v_1; + break; + } + return true; + }; + + this.stem = /** @return {boolean} */ function() { + lab0: { + /** @const */ var /** number */ v_1 = base.cursor; + lab1: { + if (!r_exception1()) + { + break lab1; + } + break lab0; + } + base.cursor = v_1; + lab2: { + { + /** @const */ var /** number */ v_2 = base.cursor; + lab3: { + { + /** @const */ var /** number */ c1 = base.cursor + 3; + if (c1 > base.limit) + { + break lab3; + } + base.cursor = c1; + } + break lab2; + } + base.cursor = v_2; + } + break lab0; + } + base.cursor = v_1; + r_prelude(); + r_mark_regions(); + base.limit_backward = base.cursor; base.cursor = base.limit; + /** @const */ var /** number */ v_3 = base.limit - base.cursor; + r_Step_1a(); + base.cursor = base.limit - v_3; + /** @const */ var /** number */ v_4 = base.limit - base.cursor; + r_Step_1b(); + base.cursor = base.limit - v_4; + /** @const */ var /** number */ v_5 = base.limit - base.cursor; + r_Step_1c(); + base.cursor = base.limit - v_5; + /** @const */ var /** number */ v_6 = base.limit - base.cursor; + r_Step_2(); + base.cursor = base.limit - v_6; + /** @const */ var /** number */ v_7 = base.limit - base.cursor; + r_Step_3(); + base.cursor = base.limit - v_7; + /** @const */ var /** number */ v_8 = base.limit - base.cursor; + r_Step_4(); + base.cursor = base.limit - v_8; + /** @const */ var /** number */ v_9 = base.limit - base.cursor; + r_Step_5(); + base.cursor = base.limit - v_9; + base.cursor = base.limit_backward; + /** @const */ var /** number */ v_10 = base.cursor; + r_postlude(); + base.cursor = v_10; + } + return true; + }; + + /**@return{string}*/ + this['stemWord'] = function(/**string*/word) { + base.setCurrent(word); + this.stem(); + return base.getCurrent(); + }; +};
diff --git a/docs/main/_static/language_data.js b/docs/main/_static/language_data.js index c7fe6c6..5776786 100644 --- a/docs/main/_static/language_data.js +++ b/docs/main/_static/language_data.js
@@ -1,192 +1,13 @@ /* * This script contains the language-specific data used by searchtools.js, - * namely the list of stopwords, stemmer, scorer and splitter. + * namely the set 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"]; +const stopwords = new Set(["a", "about", "above", "after", "again", "against", "all", "am", "an", "and", "any", "are", "aren't", "as", "at", "be", "because", "been", "before", "being", "below", "between", "both", "but", "by", "can't", "cannot", "could", "couldn't", "did", "didn't", "do", "does", "doesn't", "doing", "don't", "down", "during", "each", "few", "for", "from", "further", "had", "hadn't", "has", "hasn't", "have", "haven't", "having", "he", "he'd", "he'll", "he's", "her", "here", "here's", "hers", "herself", "him", "himself", "his", "how", "how's", "i", "i'd", "i'll", "i'm", "i've", "if", "in", "into", "is", "isn't", "it", "it's", "its", "itself", "let's", "me", "more", "most", "mustn't", "my", "myself", "no", "nor", "not", "of", "off", "on", "once", "only", "or", "other", "ought", "our", "ours", "ourselves", "out", "over", "own", "same", "shan't", "she", "she'd", "she'll", "she's", "should", "shouldn't", "so", "some", "such", "than", "that", "that's", "the", "their", "theirs", "them", "themselves", "then", "there", "there's", "these", "they", "they'd", "they'll", "they're", "they've", "this", "those", "through", "to", "too", "under", "until", "up", "very", "was", "wasn't", "we", "we'd", "we'll", "we're", "we've", "were", "weren't", "what", "what's", "when", "when's", "where", "where's", "which", "while", "who", "who's", "whom", "why", "why's", "with", "won't", "would", "wouldn't", "you", "you'd", "you'll", "you're", "you've", "your", "yours", "yourself", "yourselves"]); +window.stopwords = stopwords; // Export to global scope -/* 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; - } -} - +/* Non-minified versions are copied as separate JavaScript files, if available */ +BaseStemmer=function(){this.current="",this.cursor=0,this.limit=0,this.limit_backward=0,this.bra=0,this.ket=0,this.setCurrent=function(t){this.current=t,this.cursor=0,this.limit=this.current.length,this.limit_backward=0,this.bra=this.cursor,this.ket=this.limit},this.getCurrent=function(){return this.current},this.copy_from=function(t){this.current=t.current,this.cursor=t.cursor,this.limit=t.limit,this.limit_backward=t.limit_backward,this.bra=t.bra,this.ket=t.ket},this.in_grouping=function(t,r,i){return!(this.cursor>=this.limit||i<(i=this.current.charCodeAt(this.cursor))||i<r||0==(t[(i-=r)>>>3]&1<<(7&i))||(this.cursor++,0))},this.go_in_grouping=function(t,r,i){for(;this.cursor<this.limit;){var s=this.current.charCodeAt(this.cursor);if(i<s||s<r)return!0;if(0==(t[(s-=r)>>>3]&1<<(7&s)))return!0;this.cursor++}return!1},this.in_grouping_b=function(t,r,i){return!(this.cursor<=this.limit_backward||i<(i=this.current.charCodeAt(this.cursor-1))||i<r||0==(t[(i-=r)>>>3]&1<<(7&i))||(this.cursor--,0))},this.go_in_grouping_b=function(t,r,i){for(;this.cursor>this.limit_backward;){var s=this.current.charCodeAt(this.cursor-1);if(i<s||s<r)return!0;if(0==(t[(s-=r)>>>3]&1<<(7&s)))return!0;this.cursor--}return!1},this.out_grouping=function(t,r,i){return!(this.cursor>=this.limit)&&(i<(i=this.current.charCodeAt(this.cursor))||i<r||0==(t[(i-=r)>>>3]&1<<(7&i)))&&(this.cursor++,!0)},this.go_out_grouping=function(t,r,i){for(;this.cursor<this.limit;){var s=this.current.charCodeAt(this.cursor);if(s<=i&&r<=s&&0!=(t[(s-=r)>>>3]&1<<(7&s)))return!0;this.cursor++}return!1},this.out_grouping_b=function(t,r,i){return!(this.cursor<=this.limit_backward)&&(i<(i=this.current.charCodeAt(this.cursor-1))||i<r||0==(t[(i-=r)>>>3]&1<<(7&i)))&&(this.cursor--,!0)},this.go_out_grouping_b=function(t,r,i){for(;this.cursor>this.limit_backward;){var s=this.current.charCodeAt(this.cursor-1);if(s<=i&&r<=s&&0!=(t[(s-=r)>>>3]&1<<(7&s)))return!0;this.cursor--}return!1},this.eq_s=function(t){return!(this.limit-this.cursor<t.length||this.current.slice(this.cursor,this.cursor+t.length)!=t||(this.cursor+=t.length,0))},this.eq_s_b=function(t){return!(this.cursor-this.limit_backward<t.length||this.current.slice(this.cursor-t.length,this.cursor)!=t||(this.cursor-=t.length,0))},this.find_among=function(t){for(var r=0,i=t.length,s=this.cursor,h=this.limit,e=0,n=0,c=!1;;){for(var u=r+(i-r>>>1),o=0,a=e<n?e:n,l=t[u],f=a;f<l[0].length;f++){if(s+a==h){o=-1;break}if(0!=(o=this.current.charCodeAt(s+a)-l[0].charCodeAt(f)))break;a++}if(o<0?(i=u,n=a):(r=u,e=a),i-r<=1){if(0<r)break;if(i==r)break;if(c)break;c=!0}}do{if(e>=(l=t[r])[0].length){if(this.cursor=s+l[0].length,l.length<4)return l[2];var g=l[3](this);if(this.cursor=s+l[0].length,g)return l[2]}}while(0<=(r=l[1]));return 0},this.find_among_b=function(t){for(var r=0,i=t.length,s=this.cursor,h=this.limit_backward,e=0,n=0,c=!1;;){for(var u,o=r+(i-r>>1),a=0,l=e<n?e:n,f=(u=t[o])[0].length-1-l;0<=f;f--){if(s-l==h){a=-1;break}if(0!=(a=this.current.charCodeAt(s-1-l)-u[0].charCodeAt(f)))break;l++}if(a<0?(i=o,n=l):(r=o,e=l),i-r<=1){if(0<r)break;if(i==r)break;if(c)break;c=!0}}do{if(e>=(u=t[r])[0].length){if(this.cursor=s-u[0].length,u.length<4)return u[2];var g=u[3](this);if(this.cursor=s-u[0].length,g)return u[2]}}while(0<=(r=u[1]));return 0},this.replace_s=function(t,r,i){var s=i.length-(r-t);return this.current=this.current.slice(0,t)+i+this.current.slice(r),this.limit+=s,this.cursor>=r?this.cursor+=s:this.cursor>t&&(this.cursor=t),s},this.slice_check=function(){return!(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>this.current.length)},this.slice_from=function(t){var r=!1;return this.slice_check()&&(this.replace_s(this.bra,this.ket,t),r=!0),r},this.slice_del=function(){return this.slice_from("")},this.insert=function(t,r,i){r=this.replace_s(t,r,i);t<=this.bra&&(this.bra+=r),t<=this.ket&&(this.ket+=r)},this.slice_to=function(){var t="";return t=this.slice_check()?this.current.slice(this.bra,this.ket):t},this.assign_to=function(){return this.current.slice(0,this.limit)}}; +var EnglishStemmer=function(){var a=new BaseStemmer,c=[["arsen",-1,-1],["commun",-1,-1],["emerg",-1,-1],["gener",-1,-1],["later",-1,-1],["organ",-1,-1],["past",-1,-1],["univers",-1,-1]],o=[["'",-1,1],["'s'",0,1],["'s",-1,1]],u=[["ied",-1,2],["s",-1,3],["ies",1,2],["sses",1,1],["ss",1,-1],["us",1,-1]],t=[["succ",-1,1],["proc",-1,1],["exc",-1,1]],l=[["even",-1,2],["cann",-1,2],["inn",-1,2],["earr",-1,2],["herr",-1,2],["out",-1,2],["y",-1,1]],n=[["",-1,-1],["ed",0,2],["eed",1,1],["ing",0,3],["edly",0,2],["eedly",4,1],["ingly",0,2]],f=[["",-1,3],["bb",0,2],["dd",0,2],["ff",0,2],["gg",0,2],["bl",0,1],["mm",0,2],["nn",0,2],["pp",0,2],["rr",0,2],["at",0,1],["tt",0,2],["iz",0,1]],_=[["anci",-1,3],["enci",-1,2],["ogi",-1,14],["li",-1,16],["bli",3,12],["abli",4,4],["alli",3,8],["fulli",3,9],["lessli",3,15],["ousli",3,10],["entli",3,5],["aliti",-1,8],["biliti",-1,12],["iviti",-1,11],["tional",-1,1],["ational",14,7],["alism",-1,8],["ation",-1,7],["ization",17,6],["izer",-1,6],["ator",-1,7],["iveness",-1,11],["fulness",-1,9],["ousness",-1,10],["ogist",-1,13]],m=[["icate",-1,4],["ative",-1,6],["alize",-1,3],["iciti",-1,4],["ical",-1,4],["tional",-1,1],["ational",5,2],["ful",-1,5],["ness",-1,5]],b=[["ic",-1,1],["ance",-1,1],["ence",-1,1],["able",-1,1],["ible",-1,1],["ate",-1,1],["ive",-1,1],["ize",-1,1],["iti",-1,1],["al",-1,1],["ism",-1,1],["ion",-1,2],["er",-1,1],["ous",-1,1],["ant",-1,1],["ent",-1,1],["ment",15,1],["ement",16,1]],k=[["e",-1,1],["l",-1,2]],g=[["andes",-1,-1],["atlas",-1,-1],["bias",-1,-1],["cosmos",-1,-1],["early",-1,5],["gently",-1,3],["howe",-1,-1],["idly",-1,2],["news",-1,-1],["only",-1,6],["singly",-1,7],["skies",-1,1],["sky",-1,-1],["ugly",-1,4]],d=[17,64],v=[17,65,16,1],i=[1,17,65,208,1],w=[55,141,2],p=!1,y=0,h=0;function q(){var r=a.limit-a.cursor;return!!(a.out_grouping_b(i,89,121)&&a.in_grouping_b(v,97,121)&&a.out_grouping_b(v,97,121)||(a.cursor=a.limit-r,a.out_grouping_b(v,97,121)&&a.in_grouping_b(v,97,121)&&!(a.cursor>a.limit_backward))||(a.cursor=a.limit-r,a.eq_s_b("past")))}function z(){return h<=a.cursor}function Y(){return y<=a.cursor}this.stem=function(){var r=a.cursor;if(!(()=>{var r;if(a.bra=a.cursor,0!=(r=a.find_among(g))&&(a.ket=a.cursor,!(a.cursor<a.limit))){switch(r){case 1:if(a.slice_from("sky"))break;return;case 2:if(a.slice_from("idl"))break;return;case 3:if(a.slice_from("gentl"))break;return;case 4:if(a.slice_from("ugli"))break;return;case 5:if(a.slice_from("earli"))break;return;case 6:if(a.slice_from("onli"))break;return;case 7:if(a.slice_from("singl"))break;return}return 1}})()){a.cursor=r;var i=a.cursor,e=a.cursor+3;if(e>a.limit)a.cursor=i;else{a.cursor=e,a.cursor=r,(()=>{p=!1;var r=a.cursor;if(a.bra=a.cursor,!a.eq_s("'")||(a.ket=a.cursor,a.slice_del())){a.cursor=r;r=a.cursor;if(a.bra=a.cursor,a.eq_s("y")){if(a.ket=a.cursor,!a.slice_from("Y"))return;p=!0}a.cursor=r;for(r=a.cursor;;){var i=a.cursor;r:{for(;;){var e=a.cursor;if(a.in_grouping(v,97,121)&&(a.bra=a.cursor,a.eq_s("y"))){a.ket=a.cursor,a.cursor=e;break}if(a.cursor=e,a.cursor>=a.limit)break r;a.cursor++}if(!a.slice_from("Y"))return;p=!0;continue}a.cursor=i;break}a.cursor=r}})(),h=a.limit,y=a.limit;i=a.cursor;r:{var s=a.cursor;if(0==a.find_among(c)){if(a.cursor=s,!a.go_out_grouping(v,97,121))break r;if(a.cursor++,!a.go_in_grouping(v,97,121))break r;a.cursor++}h=a.cursor,a.go_out_grouping(v,97,121)&&(a.cursor++,a.go_in_grouping(v,97,121))&&(a.cursor++,y=a.cursor)}a.cursor=i,a.limit_backward=a.cursor,a.cursor=a.limit;var e=a.limit-a.cursor,r=((()=>{var r=a.limit-a.cursor;if(a.ket=a.cursor,0==a.find_among_b(o))a.cursor=a.limit-r;else if(a.bra=a.cursor,!a.slice_del())return;if(a.ket=a.cursor,0!=(r=a.find_among_b(u)))switch(a.bra=a.cursor,r){case 1:if(a.slice_from("ss"))break;return;case 2:r:{var i=a.limit-a.cursor,e=a.cursor-2;if(!(e<a.limit_backward)){if(a.cursor=e,a.slice_from("i"))break r;return}if(a.cursor=a.limit-i,!a.slice_from("ie"))return}break;case 3:if(a.cursor<=a.limit_backward)return;if(a.cursor--,!a.go_out_grouping_b(v,97,121))return;if(a.cursor--,a.slice_del())break}})(),a.cursor=a.limit-e,a.limit-a.cursor),i=((()=>{a.ket=a.cursor,o=a.find_among_b(n),a.bra=a.cursor;r:{var r=a.limit-a.cursor;i:{switch(o){case 1:var i=a.limit-a.cursor;e:{var e=a.limit-a.cursor;if(0==a.find_among_b(t)||a.cursor>a.limit_backward){if(a.cursor=a.limit-e,!z())break e;if(!a.slice_from("ee"))return}}a.cursor=a.limit-i;break;case 2:break i;case 3:if(0==(o=a.find_among_b(l)))break i;switch(o){case 1:var s=a.limit-a.cursor;if(!a.out_grouping_b(v,97,121))break i;if(a.cursor>a.limit_backward)break i;if(a.cursor=a.limit-s,a.bra=a.cursor,a.slice_from("ie"))break;return;case 2:if(a.cursor>a.limit_backward)break i}}break r}a.cursor=a.limit-r;var c=a.limit-a.cursor;if(!a.go_out_grouping_b(v,97,121))return;if(a.cursor--,a.cursor=a.limit-c,!a.slice_del())return;a.ket=a.cursor,a.bra=a.cursor;var o,c=a.limit-a.cursor;switch(o=a.find_among_b(f)){case 1:return a.slice_from("e");case 2:var u=a.limit-a.cursor;if(a.in_grouping_b(d,97,111)&&!(a.cursor>a.limit_backward))return;a.cursor=a.limit-u;break;case 3:return a.cursor!=h||(u=a.limit-a.cursor,q()&&(a.cursor=a.limit-u,a.slice_from("e")))}if(a.cursor=a.limit-c,a.ket=a.cursor,a.cursor<=a.limit_backward)return;if(a.cursor--,a.bra=a.cursor,!a.slice_del())return}})(),a.cursor=a.limit-r,a.limit-a.cursor),r=(a.ket=a.cursor,e=a.limit-a.cursor,(a.eq_s_b("y")||(a.cursor=a.limit-e,a.eq_s_b("Y")))&&(a.bra=a.cursor,a.out_grouping_b(v,97,121))&&a.cursor>a.limit_backward&&a.slice_from("i"),a.cursor=a.limit-i,a.limit-a.cursor),e=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(_))&&(a.bra=a.cursor,z()))switch(r){case 1:if(a.slice_from("tion"))break;return;case 2:if(a.slice_from("ence"))break;return;case 3:if(a.slice_from("ance"))break;return;case 4:if(a.slice_from("able"))break;return;case 5:if(a.slice_from("ent"))break;return;case 6:if(a.slice_from("ize"))break;return;case 7:if(a.slice_from("ate"))break;return;case 8:if(a.slice_from("al"))break;return;case 9:if(a.slice_from("ful"))break;return;case 10:if(a.slice_from("ous"))break;return;case 11:if(a.slice_from("ive"))break;return;case 12:if(a.slice_from("ble"))break;return;case 13:if(a.slice_from("og"))break;return;case 14:if(!a.eq_s_b("l"))return;if(a.slice_from("og"))break;return;case 15:if(a.slice_from("less"))break;return;case 16:if(!a.in_grouping_b(w,99,116))return;if(a.slice_del())break}})(),a.cursor=a.limit-r,a.limit-a.cursor),i=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(m))&&(a.bra=a.cursor,z()))switch(r){case 1:if(a.slice_from("tion"))break;return;case 2:if(a.slice_from("ate"))break;return;case 3:if(a.slice_from("al"))break;return;case 4:if(a.slice_from("ic"))break;return;case 5:if(a.slice_del())break;return;case 6:if(!Y())return;if(a.slice_del())break}})(),a.cursor=a.limit-e,a.limit-a.cursor),r=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(b))&&(a.bra=a.cursor,Y()))switch(r){case 1:if(a.slice_del())break;return;case 2:var i=a.limit-a.cursor;if(!a.eq_s_b("s")&&(a.cursor=a.limit-i,!a.eq_s_b("t")))return;if(a.slice_del())break}})(),a.cursor=a.limit-i,a.limit-a.cursor),e=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(k)))switch(a.bra=a.cursor,r){case 1:if(!Y()){if(!z())return;var i=a.limit-a.cursor;if(q())return;a.cursor=a.limit-i}if(a.slice_del())break;return;case 2:if(!Y())return;if(!a.eq_s_b("l"))return;if(a.slice_del())break}})(),a.cursor=a.limit-r,a.cursor=a.limit_backward,a.cursor);(()=>{if(p)for(;;){var r=a.cursor;r:{for(;;){var i=a.cursor;if(a.bra=a.cursor,a.eq_s("Y")){a.ket=a.cursor,a.cursor=i;break}if(a.cursor=i,a.cursor>=a.limit)break r;a.cursor++}if(a.slice_from("y"))continue;return}a.cursor=r;break}})(),a.cursor=e}}return!0},this.stemWord=function(r){return a.setCurrent(r),this.stem(),a.getCurrent()}}; +window.Stemmer = EnglishStemmer;
diff --git a/docs/main/_static/searchtools.js b/docs/main/_static/searchtools.js index 91f4be5..e29b1c7 100644 --- a/docs/main/_static/searchtools.js +++ b/docs/main/_static/searchtools.js
@@ -41,11 +41,12 @@ } // Global search result kind enum, used by themes to style search results. +// prettier-ignore class SearchResultKind { - static get index() { return "index"; } - static get object() { return "object"; } - static get text() { return "text"; } - static get title() { return "title"; } + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } } const _removeChildren = (element) => { @@ -58,6 +59,15 @@ const _escapeRegExp = (string) => string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string +const _escapeHTML = (text) => { + return text + .replaceAll("&", "&") + .replaceAll("<", "<") + .replaceAll(">", ">") + .replaceAll('"', """) + .replaceAll("'", "'"); +}; + const _displayItem = (item, searchTerms, highlightTerms) => { const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; @@ -90,25 +100,30 @@ let linkEl = listItem.appendChild(document.createElement("a")); linkEl.href = linkUrl + anchor; linkEl.dataset.score = score; - linkEl.innerHTML = title; + linkEl.innerHTML = _escapeHTML(title); if (descr) { listItem.appendChild(document.createElement("span")).innerHTML = - " (" + descr + ")"; + ` (${_escapeHTML(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) + if (SPHINX_HIGHLIGHT_ENABLED) + // SPHINX_HIGHLIGHT_ENABLED is 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) + 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")); + if (SPHINX_HIGHLIGHT_ENABLED) + // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js + highlightTerms.forEach((term) => + _highlightText(listItem, term, "highlighted"), + ); }); Search.output.appendChild(listItem); }; @@ -117,14 +132,14 @@ 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." + "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); + ).replace("${resultCount}", resultCount); }; const _displayNextItem = ( results, @@ -138,7 +153,7 @@ _displayItem(results.pop(), searchTerms, highlightTerms); setTimeout( () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), - 5 + 5, ); } // search finished, update title and status message @@ -170,9 +185,10 @@ * This is the same as ``\W+`` in Python, preserving the surrogate pair area. */ if (typeof splitQuery === "undefined") { - var splitQuery = (query) => query + var splitQuery = (query) => + query .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) - .filter(term => term) // remove remaining empty strings + .filter((term) => term); // remove remaining empty strings } /** @@ -184,16 +200,23 @@ _pulse_status: -1, htmlToText: (htmlString, anchor) => { - const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + const htmlElement = new DOMParser().parseFromString( + htmlString, + "text/html", + ); for (const removalQuery of [".headerlink", "script", "style"]) { - htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + htmlElement.querySelectorAll(removalQuery).forEach((el) => { + el.remove(); + }); } if (anchor) { - const anchorContent = htmlElement.querySelector(`[role="main"] ${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.` + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`, ); } @@ -202,7 +225,7 @@ 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." + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template.", ); return ""; }, @@ -287,12 +310,8 @@ const queryTermLower = queryTerm.toLowerCase(); // maybe skip this "word" - // stopwords array is from language_data.js - if ( - stopwords.indexOf(queryTermLower) !== -1 || - queryTerm.match(/^\d+$/) - ) - return; + // stopwords set is from language_data.js + if (stopwords.has(queryTermLower) || queryTerm.match(/^\d+$/)) return; // stem the word let word = stemmer.stemWord(queryTermLower); @@ -304,8 +323,12 @@ } }); - if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js - localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + if (SPHINX_HIGHLIGHT_ENABLED) { + // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js + localStorage.setItem( + "sphinx_highlight_terms", + [...highlightTerms].join(" "), + ); } // console.debug("SEARCH: searching for:"); @@ -318,7 +341,13 @@ /** * execute search (requires search index to be loaded) */ - _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + _performSearch: ( + query, + searchTerms, + excludedTerms, + highlightTerms, + objectTerms, + ) => { const filenames = Search._index.filenames; const docNames = Search._index.docnames; const titles = Search._index.titles; @@ -334,10 +363,15 @@ const queryLower = query.toLowerCase().trim(); for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + 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 + 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, @@ -353,9 +387,9 @@ // search for explicit entries in index directives for (const [entry, foundEntries] of Object.entries(indexEntries)) { - if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + 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 score = Math.round((100 * queryLower.length) / entry.length); const result = [ docNames[file], titles[file], @@ -376,11 +410,13 @@ // lookup as object objectTerms.forEach((term) => - normalResults.push(...Search.performObjectSearch(term, objectTerms)) + normalResults.push(...Search.performObjectSearch(term, objectTerms)), ); // lookup as search terms in fulltext - normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + normalResults.push( + ...Search.performTermsSearch(searchTerms, excludedTerms), + ); // let the scorer override scores with a custom scoring function if (Scorer.score) { @@ -401,7 +437,11 @@ // 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(','); + let resultStr = result + .slice(0, 4) + .concat([result[5]]) + .map((v) => String(v)) + .join(","); if (!seen.has(resultStr)) { acc.push(result); seen.add(resultStr); @@ -413,8 +453,20 @@ }, query: (query) => { - const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); - const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + 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 @@ -437,7 +489,7 @@ const results = []; const objectSearchCallback = (prefix, match) => { - const name = match[4] + const name = match[4]; const fullname = (prefix ? prefix + "." : "") + name; const fullnameLower = fullname.toLowerCase(); if (fullnameLower.indexOf(object) < 0) return; @@ -489,9 +541,7 @@ ]); }; Object.keys(objects).forEach((prefix) => - objects[prefix].forEach((array) => - objectSearchCallback(prefix, array) - ) + objects[prefix].forEach((array) => objectSearchCallback(prefix, array)), ); return results; }, @@ -516,8 +566,14 @@ // 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 }, + { + 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) { @@ -558,7 +614,8 @@ // 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); + else if (fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); }); }); @@ -569,11 +626,11 @@ // as search terms with length < 3 are discarded const filteredTermCount = [...searchTerms].filter( - (term) => term.length > 2 + (term) => term.length > 2, ).length; if ( - wordList.length !== searchTerms.size && - wordList.length !== filteredTermCount + wordList.length !== searchTerms.size + && wordList.length !== filteredTermCount ) continue; @@ -581,10 +638,10 @@ if ( [...excludedTerms].some( (term) => - terms[term] === file || - titleTerms[term] === file || - (terms[term] || []).includes(file) || - (titleTerms[term] || []).includes(file) + terms[term] === file + || titleTerms[term] === file + || (terms[term] || []).includes(file) + || (titleTerms[term] || []).includes(file), ) ) break; @@ -626,7 +683,8 @@ let summary = document.createElement("p"); summary.classList.add("context"); - summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + summary.textContent = + top + text.substr(startWithContext, 240).trim() + tail; return summary; },
diff --git a/docs/main/_static/sphinx_highlight.js b/docs/main/_static/sphinx_highlight.js index 8a96c69..a74e103 100644 --- a/docs/main/_static/sphinx_highlight.js +++ b/docs/main/_static/sphinx_highlight.js
@@ -1,7 +1,7 @@ /* Highlighting utilities for Sphinx HTML documentation. */ "use strict"; -const SPHINX_HIGHLIGHT_ENABLED = true +const SPHINX_HIGHLIGHT_ENABLED = true; /** * highlight a given string on a node by wrapping it in @@ -13,9 +13,9 @@ const parent = node.parentNode; const pos = val.toLowerCase().indexOf(text); if ( - pos >= 0 && - !parent.classList.contains(className) && - !parent.classList.contains("nohighlight") + pos >= 0 + && !parent.classList.contains(className) + && !parent.classList.contains("nohighlight") ) { let span; @@ -30,13 +30,7 @@ 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 - ) - ); + 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. @@ -46,7 +40,7 @@ if (isInSVG) { const rect = document.createElementNS( "http://www.w3.org/2000/svg", - "rect" + "rect", ); const bbox = parent.getBBox(); rect.x.baseVal.value = bbox.x; @@ -65,7 +59,7 @@ let addItems = []; _highlight(thisNode, addItems, text, className); addItems.forEach((obj) => - obj.parent.insertAdjacentElement("beforebegin", obj.target) + obj.parent.insertAdjacentElement("beforebegin", obj.target), ); }; @@ -73,25 +67,31 @@ * 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 + 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); + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms"); + // Update history only if '?highlight' is present; otherwise it + // clears text fragments (not set in window.location by the browser) + if (url.searchParams.has("highlight")) { + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + } // get individual terms from highlight string - const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + 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" @@ -107,11 +107,11 @@ document .createRange() .createContextualFragment( - '<p class="highlight-link">' + - '<a href="javascript:SphinxHighlight.hideSearchWords()">' + - _("Hide Search Matches") + - "</a></p>" - ) + '<p class="highlight-link">' + + '<a href="javascript:SphinxHighlight.hideSearchWords()">' + + _("Hide Search Matches") + + "</a></p>", + ), ); }, @@ -125,7 +125,7 @@ document .querySelectorAll("span.highlighted") .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms") + localStorage.removeItem("sphinx_highlight_terms"); }, initEscapeListener: () => { @@ -134,10 +134,15 @@ document.addEventListener("keydown", (event) => { // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + 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")) { + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) + return; + if ( + DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + && event.key === "Escape" + ) { SphinxHighlight.hideSearchWords(); event.preventDefault(); }
diff --git a/docs/main/distinct_counting/cpc.html b/docs/main/distinct_counting/cpc.html index 2d87ef5..1507fd5 100644 --- a/docs/main/distinct_counting/cpc.html +++ b/docs/main/distinct_counting/cpc.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Compressed Probabilistic Counting (CPC) — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -49,20 +49,20 @@ <li class="toctree-l3"><a class="reference internal" href="#datasketches.cpc_sketch"><code class="docutils literal notranslate"><span class="pre">cpc_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.get_estimate</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.get_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.get_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.is_empty</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.get_estimate()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.get_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.get_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.is_empty()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.lg_k"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.lg_k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.update"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_sketch.update"><code class="docutils literal notranslate"><span class="pre">cpc_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.cpc_union"><code class="docutils literal notranslate"><span class="pre">cpc_union</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_union.__init__"><code class="docutils literal notranslate"><span class="pre">cpc_union.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_union.get_result"><code class="docutils literal notranslate"><span class="pre">cpc_union.get_result</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_union.update"><code class="docutils literal notranslate"><span class="pre">cpc_union.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_union.get_result"><code class="docutils literal notranslate"><span class="pre">cpc_union.get_result()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.cpc_union.update"><code class="docutils literal notranslate"><span class="pre">cpc_union.update()</span></code></a></li> </ul> </li> </ul> @@ -125,7 +125,7 @@ For additional security this sketch can be configured with a user-specified hash seed.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.cpc_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cpc_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.cpc_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">cpc_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.cpc_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_sketch.deserialize"> @@ -148,51 +148,55 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_sketch.get_estimate"> -<span class="sig-name descname"><span class="pre">get_estimate</span></span><a class="headerlink" href="#datasketches.cpc_sketch.get_estimate" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.cpc_sketch.get_estimate" title="Link to this definition"></a></dt> <dd><p>Estimate of the distinct count of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_sketch.get_lower_bound"> -<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><a class="headerlink" href="#datasketches.cpc_sketch.get_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kappa</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.cpc_sketch.get_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate lower bound on the estimate for kappa values in {1, 2, 3}, roughly corresponding to standard deviations</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_sketch.get_upper_bound"> -<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><a class="headerlink" href="#datasketches.cpc_sketch.get_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kappa</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.cpc_sketch.get_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate upper bound on the estimate for kappa values in {1, 2, 3}, roughly corresponding to standard deviations</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.cpc_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.cpc_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.cpc_sketch.lg_k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lg_k</span></span><a class="headerlink" href="#datasketches.cpc_sketch.lg_k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">lg_k</span></span><a class="headerlink" href="#datasketches.cpc_sketch.lg_k" title="Link to this definition"></a></dt> <dd><p>Configured lg_k of this sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.cpc_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.cpc_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.cpc_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.cpc_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.cpc_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.cpc_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">datum:</span> <span class="pre">int)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -212,21 +216,21 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.cpc_union"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cpc_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.cpc_union" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">cpc_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.cpc_union" title="Link to this definition"></a></dt> <dd><dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_union.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lg_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9001</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.cpc_union.__init__" title="Link to this definition"></a></dt> <dd></dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_union.get_result"> -<span class="sig-name descname"><span class="pre">get_result</span></span><a class="headerlink" href="#datasketches.cpc_union.get_result" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.cpc_sketch" title="_datasketches.cpc_sketch"><span class="pre">_datasketches.cpc_sketch</span></a></span></span><a class="headerlink" href="#datasketches.cpc_union.get_result" title="Link to this definition"></a></dt> <dd><p>Returns a CPC sketch with the result of the union</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.cpc_union.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.cpc_union.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.cpc_sketch" title="_datasketches.cpc_sketch"><span class="pre">_datasketches.cpc_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.cpc_union.update" title="Link to this definition"></a></dt> <dd><p>Updates the union with the provided CPC sketch</p> </dd></dl>
diff --git a/docs/main/distinct_counting/hyper_log_log.html b/docs/main/distinct_counting/hyper_log_log.html index a60930e..8a5e8ce 100644 --- a/docs/main/distinct_counting/hyper_log_log.html +++ b/docs/main/distinct_counting/hyper_log_log.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>HyperLogLog (HLL) — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -56,33 +56,33 @@ <li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_max_updatable_serialization_bytes"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_max_updatable_serialization_bytes()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_rel_err"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_rel_err()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">hll_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_compact_serialization_bytes"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_compact_serialization_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_estimate</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_updatable_serialization_bytes"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_updatable_serialization_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.is_compact"><code class="docutils literal notranslate"><span class="pre">hll_sketch.is_compact</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">hll_sketch.is_empty</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_compact_serialization_bytes"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_compact_serialization_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_estimate()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_updatable_serialization_bytes"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_updatable_serialization_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.is_compact"><code class="docutils literal notranslate"><span class="pre">hll_sketch.is_compact()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">hll_sketch.is_empty()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.lg_config_k"><code class="docutils literal notranslate"><span class="pre">hll_sketch.lg_config_k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.reset"><code class="docutils literal notranslate"><span class="pre">hll_sketch.reset</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.serialize_compact"><code class="docutils literal notranslate"><span class="pre">hll_sketch.serialize_compact</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.serialize_updatable"><code class="docutils literal notranslate"><span class="pre">hll_sketch.serialize_updatable</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.reset"><code class="docutils literal notranslate"><span class="pre">hll_sketch.reset()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.serialize_compact"><code class="docutils literal notranslate"><span class="pre">hll_sketch.serialize_compact()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.serialize_updatable"><code class="docutils literal notranslate"><span class="pre">hll_sketch.serialize_updatable()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.tgt_type"><code class="docutils literal notranslate"><span class="pre">hll_sketch.tgt_type</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">hll_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.update"><code class="docutils literal notranslate"><span class="pre">hll_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">hll_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_sketch.update"><code class="docutils literal notranslate"><span class="pre">hll_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_union"><code class="docutils literal notranslate"><span class="pre">hll_union</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.get_rel_err"><code class="docutils literal notranslate"><span class="pre">hll_union.get_rel_err()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.__init__"><code class="docutils literal notranslate"><span class="pre">hll_union.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.get_estimate"><code class="docutils literal notranslate"><span class="pre">hll_union.get_estimate</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">hll_union.get_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.get_result"><code class="docutils literal notranslate"><span class="pre">hll_union.get_result</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">hll_union.get_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.is_empty"><code class="docutils literal notranslate"><span class="pre">hll_union.is_empty</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.get_estimate"><code class="docutils literal notranslate"><span class="pre">hll_union.get_estimate()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">hll_union.get_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.get_result"><code class="docutils literal notranslate"><span class="pre">hll_union.get_result()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">hll_union.get_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.is_empty"><code class="docutils literal notranslate"><span class="pre">hll_union.is_empty()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.lg_config_k"><code class="docutils literal notranslate"><span class="pre">hll_union.lg_config_k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.reset"><code class="docutils literal notranslate"><span class="pre">hll_union.reset</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.update"><code class="docutils literal notranslate"><span class="pre">hll_union.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.reset"><code class="docutils literal notranslate"><span class="pre">hll_union.reset()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.hll_union.update"><code class="docutils literal notranslate"><span class="pre">hll_union.update()</span></code></a></li> </ul> </li> </ul> @@ -145,28 +145,28 @@ <p>During warmup, when the sketch has only received a small number of unique items (up to about 10% of <code class="docutils literal notranslate"><span class="pre">k</span></code>), this implementation leverages a new class of estimator algorithms with significantly better accuracy.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.tgt_hll_type"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tgt_hll_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tgt_hll_type" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">tgt_hll_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tgt_hll_type" title="Link to this definition"></a></dt> <dd><p>Target HLL flavor</p> <dl class="py attribute"> <dt class="sig sig-object py" id="datasketches.tgt_hll_type.HLL_4"> -<span class="sig-name descname"><span class="pre">HLL_4</span></span><em class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">4</span> <span class="pre">bits</span> <span class="pre">per</span> <span class="pre">entry</span></em><a class="headerlink" href="#datasketches.tgt_hll_type.HLL_4" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">HLL_4</span></span><span class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">4</span> <span class="pre">bits</span> <span class="pre">per</span> <span class="pre">entry</span></span><a class="headerlink" href="#datasketches.tgt_hll_type.HLL_4" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="datasketches.tgt_hll_type.HLL_6"> -<span class="sig-name descname"><span class="pre">HLL_6</span></span><em class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">6</span> <span class="pre">bits</span> <span class="pre">per</span> <span class="pre">entry</span></em><a class="headerlink" href="#datasketches.tgt_hll_type.HLL_6" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">HLL_6</span></span><span class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">6</span> <span class="pre">bits</span> <span class="pre">per</span> <span class="pre">entry</span></span><a class="headerlink" href="#datasketches.tgt_hll_type.HLL_6" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="datasketches.tgt_hll_type.HLL_8"> -<span class="sig-name descname"><span class="pre">HLL_8</span></span><em class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">8</span> <span class="pre">bits</span> <span class="pre">per</span> <span class="pre">entry</span></em><a class="headerlink" href="#datasketches.tgt_hll_type.HLL_8" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">HLL_8</span></span><span class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">8</span> <span class="pre">bits</span> <span class="pre">per</span> <span class="pre">entry</span></span><a class="headerlink" href="#datasketches.tgt_hll_type.HLL_8" title="Link to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.hll_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hll_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.hll_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">hll_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.hll_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.deserialize"> @@ -202,87 +202,91 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.get_compact_serialization_bytes"> -<span class="sig-name descname"><span class="pre">get_compact_serialization_bytes</span></span><a class="headerlink" href="#datasketches.hll_sketch.get_compact_serialization_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_compact_serialization_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_compact_serialization_bytes" title="Link to this definition"></a></dt> <dd><p>Returns the size of the serialized sketch when compressing the exception table if HLL_4</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.get_estimate"> -<span class="sig-name descname"><span class="pre">get_estimate</span></span><a class="headerlink" href="#datasketches.hll_sketch.get_estimate" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_estimate" title="Link to this definition"></a></dt> <dd><p>Estimate of the distinct count of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.get_lower_bound"> -<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><a class="headerlink" href="#datasketches.hll_sketch.get_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns the approximate lower error bound given the specified number of standard deviations in {1, 2, 3}</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.get_updatable_serialization_bytes"> -<span class="sig-name descname"><span class="pre">get_updatable_serialization_bytes</span></span><a class="headerlink" href="#datasketches.hll_sketch.get_updatable_serialization_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_updatable_serialization_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_updatable_serialization_bytes" title="Link to this definition"></a></dt> <dd><p>Returns the size of the serialized sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.get_upper_bound"> -<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><a class="headerlink" href="#datasketches.hll_sketch.get_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns the approximate upper error bound given the specified number of standard deviations in {1, 2, 3}</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.is_compact"> -<span class="sig-name descname"><span class="pre">is_compact</span></span><a class="headerlink" href="#datasketches.hll_sketch.is_compact" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_compact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.is_compact" title="Link to this definition"></a></dt> <dd><p>True if the sketch is compact, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.hll_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>True if the sketch is empty, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.hll_sketch.lg_config_k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lg_config_k</span></span><a class="headerlink" href="#datasketches.hll_sketch.lg_config_k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">lg_config_k</span></span><a class="headerlink" href="#datasketches.hll_sketch.lg_config_k" title="Link to this definition"></a></dt> <dd><p>Configured lg_k value for the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.reset"> -<span class="sig-name descname"><span class="pre">reset</span></span><a class="headerlink" href="#datasketches.hll_sketch.reset" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.reset" title="Link to this definition"></a></dt> <dd><p>Resets the sketch to the empty state in coupon collection mode</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.serialize_compact"> -<span class="sig-name descname"><span class="pre">serialize_compact</span></span><a class="headerlink" href="#datasketches.hll_sketch.serialize_compact" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize_compact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.serialize_compact" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object, compressing the exception table if HLL_4</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.serialize_updatable"> -<span class="sig-name descname"><span class="pre">serialize_updatable</span></span><a class="headerlink" href="#datasketches.hll_sketch.serialize_updatable" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize_updatable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.serialize_updatable" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.hll_sketch.tgt_type"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tgt_type</span></span><a class="headerlink" href="#datasketches.hll_sketch.tgt_type" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">tgt_type</span></span><a class="headerlink" href="#datasketches.hll_sketch.tgt_type" title="Link to this definition"></a></dt> <dd><p>The HLL type (4, 6, or 8) when in estimation mode</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.hll_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aux_detail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.hll_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">datum:</span> <span class="pre">int)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -302,7 +306,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.hll_union"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hll_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.hll_union" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">hll_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.hll_union" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_union.get_rel_err"> @@ -322,51 +326,57 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_union.get_estimate"> -<span class="sig-name descname"><span class="pre">get_estimate</span></span><a class="headerlink" href="#datasketches.hll_union.get_estimate" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_union.get_estimate" title="Link to this definition"></a></dt> <dd><p>Estimate of the distinct count of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_union.get_lower_bound"> -<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><a class="headerlink" href="#datasketches.hll_union.get_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_union.get_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns the approximate lower error bound given the specified number of standard deviations in {1, 2, 3}</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_union.get_result"> -<span class="sig-name descname"><span class="pre">get_result</span></span><a class="headerlink" href="#datasketches.hll_union.get_result" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tgt_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.tgt_hll_type" title="_datasketches.tgt_hll_type"><span class="pre">_datasketches.tgt_hll_type</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">tgt_hll_type.HLL_4</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></span><a class="headerlink" href="#datasketches.hll_union.get_result" title="Link to this definition"></a></dt> <dd><p>Returns a sketch of the target type representing the current union state</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_union.get_upper_bound"> -<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><a class="headerlink" href="#datasketches.hll_union.get_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_union.get_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns the approximate upper error bound given the specified number of standard deviations in {1, 2, 3}</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_union.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.hll_union.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.hll_union.is_empty" title="Link to this definition"></a></dt> <dd><p>True if the union is empty, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.hll_union.lg_config_k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lg_config_k</span></span><a class="headerlink" href="#datasketches.hll_union.lg_config_k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">lg_config_k</span></span><a class="headerlink" href="#datasketches.hll_union.lg_config_k" title="Link to this definition"></a></dt> <dd><p>Configured lg_k value for the union</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_union.reset"> -<span class="sig-name descname"><span class="pre">reset</span></span><a class="headerlink" href="#datasketches.hll_union.reset" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.hll_union.reset" title="Link to this definition"></a></dt> <dd><p>Resets the union to the empty state</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.hll_union.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.hll_union.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.hll_union.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">sketch:</span> <span class="pre">_datasketches.hll_sketch)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li>
diff --git a/docs/main/distinct_counting/index.html b/docs/main/distinct_counting/index.html index ce4493d..8af292f 100644 --- a/docs/main/distinct_counting/index.html +++ b/docs/main/distinct_counting/index.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Distinct Counting — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" />
diff --git a/docs/main/distinct_counting/theta.html b/docs/main/distinct_counting/theta.html index a66a2a9..7a78821 100644 --- a/docs/main/distinct_counting/theta.html +++ b/docs/main/distinct_counting/theta.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Theta Sketch — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -48,49 +48,49 @@ <li class="toctree-l2"><a class="reference internal" href="cpc.html">Compressed Probabilistic Counting (CPC)</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Theta Sketch</a><ul> <li class="toctree-l3"><a class="reference internal" href="#datasketches.theta_sketch"><code class="docutils literal notranslate"><span class="pre">theta_sketch</span></code></a><ul> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">theta_sketch.get_estimate</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">theta_sketch.get_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.get_seed_hash"><code class="docutils literal notranslate"><span class="pre">theta_sketch.get_seed_hash</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">theta_sketch.get_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">theta_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">theta_sketch.is_estimation_mode</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.is_ordered"><code class="docutils literal notranslate"><span class="pre">theta_sketch.is_ordered</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">theta_sketch.get_estimate()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">theta_sketch.get_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.get_seed_hash"><code class="docutils literal notranslate"><span class="pre">theta_sketch.get_seed_hash()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">theta_sketch.get_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">theta_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">theta_sketch.is_estimation_mode()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.is_ordered"><code class="docutils literal notranslate"><span class="pre">theta_sketch.is_ordered()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">theta_sketch.num_retained</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.theta"><code class="docutils literal notranslate"><span class="pre">theta_sketch.theta</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.theta64"><code class="docutils literal notranslate"><span class="pre">theta_sketch.theta64</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">theta_sketch.to_string</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">theta_sketch.to_string()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.update_theta_sketch"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.update_theta_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_theta_sketch.compact"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch.compact</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_theta_sketch.reset"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch.reset</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_theta_sketch.trim"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch.trim</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_theta_sketch.update"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_theta_sketch.compact"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch.compact()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_theta_sketch.reset"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch.reset()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_theta_sketch.trim"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch.trim()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_theta_sketch.update"><code class="docutils literal notranslate"><span class="pre">update_theta_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.compact_theta_sketch"><code class="docutils literal notranslate"><span class="pre">compact_theta_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_theta_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">compact_theta_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_theta_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">compact_theta_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_theta_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">compact_theta_sketch.serialize</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_theta_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">compact_theta_sketch.serialize()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.theta_union"><code class="docutils literal notranslate"><span class="pre">theta_union</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_union.__init__"><code class="docutils literal notranslate"><span class="pre">theta_union.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_union.get_result"><code class="docutils literal notranslate"><span class="pre">theta_union.get_result</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_union.update"><code class="docutils literal notranslate"><span class="pre">theta_union.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_union.get_result"><code class="docutils literal notranslate"><span class="pre">theta_union.get_result()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_union.update"><code class="docutils literal notranslate"><span class="pre">theta_union.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.theta_intersection"><code class="docutils literal notranslate"><span class="pre">theta_intersection</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_intersection.__init__"><code class="docutils literal notranslate"><span class="pre">theta_intersection.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_intersection.get_result"><code class="docutils literal notranslate"><span class="pre">theta_intersection.get_result</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_intersection.has_result"><code class="docutils literal notranslate"><span class="pre">theta_intersection.has_result</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_intersection.update"><code class="docutils literal notranslate"><span class="pre">theta_intersection.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_intersection.get_result"><code class="docutils literal notranslate"><span class="pre">theta_intersection.get_result()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_intersection.has_result"><code class="docutils literal notranslate"><span class="pre">theta_intersection.has_result()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_intersection.update"><code class="docutils literal notranslate"><span class="pre">theta_intersection.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.theta_a_not_b"><code class="docutils literal notranslate"><span class="pre">theta_a_not_b</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_a_not_b.__init__"><code class="docutils literal notranslate"><span class="pre">theta_a_not_b.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_a_not_b.compute"><code class="docutils literal notranslate"><span class="pre">theta_a_not_b.compute</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.theta_a_not_b.compute"><code class="docutils literal notranslate"><span class="pre">theta_a_not_b.compute()</span></code></a></li> </ul> </li> </ul> @@ -155,71 +155,71 @@ measures can be computed between theta sketches with the <a class="reference internal" href="../helper/jaccard.html#datasketches.theta_jaccard_similarity" title="datasketches.theta_jaccard_similarity"><code class="xref py py-class docutils literal notranslate"><span class="pre">theta_jaccard_similarity</span></code></a> class.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.theta_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">theta_sketch</span></span><a class="headerlink" href="#datasketches.theta_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">theta_sketch</span></span><a class="headerlink" href="#datasketches.theta_sketch" title="Link to this definition"></a></dt> <dd><p>An abstract base class for theta sketches</p> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_sketch.get_estimate"> -<span class="sig-name descname"><span class="pre">get_estimate</span></span><a class="headerlink" href="#datasketches.theta_sketch.get_estimate" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.theta_sketch.get_estimate" title="Link to this definition"></a></dt> <dd><p>Estimate of the distinct count of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_sketch.get_lower_bound"> -<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><a class="headerlink" href="#datasketches.theta_sketch.get_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.theta_sketch.get_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate lower bound on the estimate at standard deviations in {1, 2, 3}</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_sketch.get_seed_hash"> -<span class="sig-name descname"><span class="pre">get_seed_hash</span></span><a class="headerlink" href="#datasketches.theta_sketch.get_seed_hash" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_seed_hash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.theta_sketch.get_seed_hash" title="Link to this definition"></a></dt> <dd><p>Returns a hash of the seed used in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_sketch.get_upper_bound"> -<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><a class="headerlink" href="#datasketches.theta_sketch.get_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.theta_sketch.get_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate upper bound on the estimate at standard deviations in {1, 2, 3}</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.theta_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.theta_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.theta_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.theta_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if sketch is in estimation mode, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_sketch.is_ordered"> -<span class="sig-name descname"><span class="pre">is_ordered</span></span><a class="headerlink" href="#datasketches.theta_sketch.is_ordered" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_ordered</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.theta_sketch.is_ordered" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch entries are sorted, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.theta_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.theta_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.theta_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of items currently in the sketch</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.theta_sketch.theta"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">theta</span></span><a class="headerlink" href="#datasketches.theta_sketch.theta" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">theta</span></span><a class="headerlink" href="#datasketches.theta_sketch.theta" title="Link to this definition"></a></dt> <dd><p>Theta (effective sampling rate) as a fraction from 0 to 1</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.theta_sketch.theta64"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">theta64</span></span><a class="headerlink" href="#datasketches.theta_sketch.theta64" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">theta64</span></span><a class="headerlink" href="#datasketches.theta_sketch.theta64" title="Link to this definition"></a></dt> <dd><p>Theta as 64-bit value</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.theta_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.theta_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> @@ -227,7 +227,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.update_theta_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_theta_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.update_theta_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">update_theta_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.update_theta_sketch" title="Link to this definition"></a></dt> <dd><dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_theta_sketch.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lg_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">12</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9001</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.update_theta_sketch.__init__" title="Link to this definition"></a></dt> @@ -243,27 +243,31 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_theta_sketch.compact"> -<span class="sig-name descname"><span class="pre">compact</span></span><a class="headerlink" href="#datasketches.update_theta_sketch.compact" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">compact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_theta_sketch" title="_datasketches.compact_theta_sketch"><span class="pre">_datasketches.compact_theta_sketch</span></a></span></span><a class="headerlink" href="#datasketches.update_theta_sketch.compact" title="Link to this definition"></a></dt> <dd><p>Returns a compacted form of the sketch, optionally sorting it</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_theta_sketch.reset"> -<span class="sig-name descname"><span class="pre">reset</span></span><a class="headerlink" href="#datasketches.update_theta_sketch.reset" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.update_theta_sketch.reset" title="Link to this definition"></a></dt> <dd><p>Resets the sketch to the initial empty state</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_theta_sketch.trim"> -<span class="sig-name descname"><span class="pre">trim</span></span><a class="headerlink" href="#datasketches.update_theta_sketch.trim" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">trim</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.update_theta_sketch.trim" title="Link to this definition"></a></dt> <dd><p>Removes retained entries in excess of the nominal size k (if any)</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_theta_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.update_theta_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.update_theta_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">datum:</span> <span class="pre">int)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -283,7 +287,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.compact_theta_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">compact_theta_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.compact_theta_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">compact_theta_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.compact_theta_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.compact_theta_sketch.deserialize"> @@ -306,9 +310,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.compact_theta_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.compact_theta_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compress</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.compact_theta_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object, optionally compressing the data</p> </dd></dl> @@ -316,7 +320,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.theta_union"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">theta_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.theta_union" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">theta_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.theta_union" title="Link to this definition"></a></dt> <dd><dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_union.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lg_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">12</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9001</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.theta_union.__init__" title="Link to this definition"></a></dt> @@ -332,15 +336,15 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_union.get_result"> -<span class="sig-name descname"><span class="pre">get_result</span></span><a class="headerlink" href="#datasketches.theta_union.get_result" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_theta_sketch" title="_datasketches.compact_theta_sketch"><span class="pre">_datasketches.compact_theta_sketch</span></a></span></span><a class="headerlink" href="#datasketches.theta_union.get_result" title="Link to this definition"></a></dt> <dd><p>Returns the sketch corresponding to the union result</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_union.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.theta_union.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.theta_sketch" title="_datasketches.theta_sketch"><span class="pre">_datasketches.theta_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.theta_union.update" title="Link to this definition"></a></dt> <dd><p>Updates the union with the given sketch</p> </dd></dl> @@ -348,7 +352,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.theta_intersection"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">theta_intersection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.theta_intersection" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">theta_intersection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.theta_intersection" title="Link to this definition"></a></dt> <dd><dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_intersection.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9001</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.theta_intersection.__init__" title="Link to this definition"></a></dt> @@ -360,21 +364,21 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_intersection.get_result"> -<span class="sig-name descname"><span class="pre">get_result</span></span><a class="headerlink" href="#datasketches.theta_intersection.get_result" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_theta_sketch" title="_datasketches.compact_theta_sketch"><span class="pre">_datasketches.compact_theta_sketch</span></a></span></span><a class="headerlink" href="#datasketches.theta_intersection.get_result" title="Link to this definition"></a></dt> <dd><p>Returns the sketch corresponding to the intersection result</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_intersection.has_result"> -<span class="sig-name descname"><span class="pre">has_result</span></span><a class="headerlink" href="#datasketches.theta_intersection.has_result" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">has_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.theta_intersection.has_result" title="Link to this definition"></a></dt> <dd><p>Returns True if the intersection has a valid result, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_intersection.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.theta_intersection.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.theta_sketch" title="_datasketches.theta_sketch"><span class="pre">_datasketches.theta_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.theta_intersection.update" title="Link to this definition"></a></dt> <dd><p>Intersections the provided sketch with the current intersection state</p> </dd></dl> @@ -382,7 +386,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.theta_a_not_b"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">theta_a_not_b</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.theta_a_not_b" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">theta_a_not_b</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.theta_a_not_b" title="Link to this definition"></a></dt> <dd><dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_a_not_b.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9001</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.theta_a_not_b.__init__" title="Link to this definition"></a></dt> @@ -394,9 +398,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_a_not_b.compute"> -<span class="sig-name descname"><span class="pre">compute</span></span><a class="headerlink" href="#datasketches.theta_a_not_b.compute" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">compute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">a</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.theta_sketch" title="_datasketches.theta_sketch"><span class="pre">_datasketches.theta_sketch</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.theta_sketch" title="_datasketches.theta_sketch"><span class="pre">_datasketches.theta_sketch</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_theta_sketch" title="_datasketches.compact_theta_sketch"><span class="pre">_datasketches.compact_theta_sketch</span></a></span></span><a class="headerlink" href="#datasketches.theta_a_not_b.compute" title="Link to this definition"></a></dt> <dd><p>Returns a sketch with the result of applying the A-not-B operation on the given inputs</p> </dd></dl>
diff --git a/docs/main/distinct_counting/tuple.html b/docs/main/distinct_counting/tuple.html index aa619a7..6b42c82 100644 --- a/docs/main/distinct_counting/tuple.html +++ b/docs/main/distinct_counting/tuple.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Tuple Sketch — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -50,52 +50,52 @@ <li class="toctree-l2 current"><a class="current reference internal" href="#">Tuple Sketch</a><ul> <li class="toctree-l3"><a class="reference internal" href="#datasketches.tuple_sketch"><code class="docutils literal notranslate"><span class="pre">tuple_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.DEFAULT_SEED"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.DEFAULT_SEED</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.get_estimate</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.get_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.get_seed_hash"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.get_seed_hash</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.get_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.is_estimation_mode</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.is_ordered"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.is_ordered</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.get_estimate()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.get_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.get_seed_hash"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.get_seed_hash()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.get_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.is_estimation_mode()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.is_ordered"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.is_ordered()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.num_retained</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.theta"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.theta</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.theta64"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.theta64</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.to_string</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">tuple_sketch.to_string()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.update_tuple_sketch"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.compact"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.compact</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.filter"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.filter</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.reset"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.reset</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.trim"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.trim</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.update"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.compact"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.compact()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.filter"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.filter()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.reset"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.reset()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.trim"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.trim()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.update_tuple_sketch.update"><code class="docutils literal notranslate"><span class="pre">update_tuple_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.compact_tuple_sketch"><code class="docutils literal notranslate"><span class="pre">compact_tuple_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_tuple_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">compact_tuple_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_tuple_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">compact_tuple_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_tuple_sketch.filter"><code class="docutils literal notranslate"><span class="pre">compact_tuple_sketch.filter</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_tuple_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">compact_tuple_sketch.serialize</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_tuple_sketch.filter"><code class="docutils literal notranslate"><span class="pre">compact_tuple_sketch.filter()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.compact_tuple_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">compact_tuple_sketch.serialize()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.tuple_union"><code class="docutils literal notranslate"><span class="pre">tuple_union</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_union.__init__"><code class="docutils literal notranslate"><span class="pre">tuple_union.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_union.get_result"><code class="docutils literal notranslate"><span class="pre">tuple_union.get_result</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_union.reset"><code class="docutils literal notranslate"><span class="pre">tuple_union.reset</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_union.update"><code class="docutils literal notranslate"><span class="pre">tuple_union.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_union.get_result"><code class="docutils literal notranslate"><span class="pre">tuple_union.get_result()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_union.reset"><code class="docutils literal notranslate"><span class="pre">tuple_union.reset()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_union.update"><code class="docutils literal notranslate"><span class="pre">tuple_union.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.tuple_intersection"><code class="docutils literal notranslate"><span class="pre">tuple_intersection</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_intersection.__init__"><code class="docutils literal notranslate"><span class="pre">tuple_intersection.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_intersection.get_result"><code class="docutils literal notranslate"><span class="pre">tuple_intersection.get_result</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_intersection.has_result"><code class="docutils literal notranslate"><span class="pre">tuple_intersection.has_result</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_intersection.update"><code class="docutils literal notranslate"><span class="pre">tuple_intersection.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_intersection.get_result"><code class="docutils literal notranslate"><span class="pre">tuple_intersection.get_result()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_intersection.has_result"><code class="docutils literal notranslate"><span class="pre">tuple_intersection.has_result()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_intersection.update"><code class="docutils literal notranslate"><span class="pre">tuple_intersection.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.tuple_a_not_b"><code class="docutils literal notranslate"><span class="pre">tuple_a_not_b</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_a_not_b.__init__"><code class="docutils literal notranslate"><span class="pre">tuple_a_not_b.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_a_not_b.compute"><code class="docutils literal notranslate"><span class="pre">tuple_a_not_b.compute</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tuple_a_not_b.compute"><code class="docutils literal notranslate"><span class="pre">tuple_a_not_b.compute()</span></code></a></li> </ul> </li> </ul> @@ -161,76 +161,76 @@ </div> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.tuple_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tuple_sketch</span></span><a class="headerlink" href="#datasketches.tuple_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">tuple_sketch</span></span><a class="headerlink" href="#datasketches.tuple_sketch" title="Link to this definition"></a></dt> <dd><p>An abstract base class for tuple sketches.</p> <dl class="py attribute"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.DEFAULT_SEED"> -<span class="sig-name descname"><span class="pre">DEFAULT_SEED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">9001</span></em><a class="headerlink" href="#datasketches.tuple_sketch.DEFAULT_SEED" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">DEFAULT_SEED</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">9001</span></span><a class="headerlink" href="#datasketches.tuple_sketch.DEFAULT_SEED" title="Link to this definition"></a></dt> <dd></dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.get_estimate"> -<span class="sig-name descname"><span class="pre">get_estimate</span></span><a class="headerlink" href="#datasketches.tuple_sketch.get_estimate" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tuple_sketch.get_estimate" title="Link to this definition"></a></dt> <dd><p>Estimate of the distinct count of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.get_lower_bound"> -<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><a class="headerlink" href="#datasketches.tuple_sketch.get_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tuple_sketch.get_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate lower bound on the estimate at standard deviations in {1, 2, 3}</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.get_seed_hash"> -<span class="sig-name descname"><span class="pre">get_seed_hash</span></span><a class="headerlink" href="#datasketches.tuple_sketch.get_seed_hash" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_seed_hash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.tuple_sketch.get_seed_hash" title="Link to this definition"></a></dt> <dd><p>Returns a hash of the seed used in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.get_upper_bound"> -<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><a class="headerlink" href="#datasketches.tuple_sketch.get_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tuple_sketch.get_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate upper bound on the estimate at standard deviations in {1, 2, 3}</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.tuple_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.tuple_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.tuple_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.tuple_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if sketch is in estimation mode, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.is_ordered"> -<span class="sig-name descname"><span class="pre">is_ordered</span></span><a class="headerlink" href="#datasketches.tuple_sketch.is_ordered" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_ordered</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.tuple_sketch.is_ordered" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch entries are sorted, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.tuple_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.tuple_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of items currently in the sketch</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.theta"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">theta</span></span><a class="headerlink" href="#datasketches.tuple_sketch.theta" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">theta</span></span><a class="headerlink" href="#datasketches.tuple_sketch.theta" title="Link to this definition"></a></dt> <dd><p>Theta (effective sampling rate) as a fraction from 0 to 1</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.theta64"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">theta64</span></span><a class="headerlink" href="#datasketches.tuple_sketch.theta64" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">theta64</span></span><a class="headerlink" href="#datasketches.tuple_sketch.theta64" title="Link to this definition"></a></dt> <dd><p>Theta as 64-bit value</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.tuple_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.tuple_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> @@ -238,7 +238,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.update_tuple_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_tuple_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.update_tuple_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">update_tuple_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.update_tuple_sketch" title="Link to this definition"></a></dt> <dd><dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_tuple_sketch.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/tuple_policy.html#datasketches.TuplePolicy" title="_datasketches.TuplePolicy"><span class="pre">_datasketches.TuplePolicy</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">lg_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">12</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9001</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.__init__" title="Link to this definition"></a></dt> @@ -255,15 +255,15 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_tuple_sketch.compact"> -<span class="sig-name descname"><span class="pre">compact</span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.compact" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">compact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_tuple_sketch" title="_datasketches.compact_tuple_sketch"><span class="pre">_datasketches.compact_tuple_sketch</span></a></span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.compact" title="Link to this definition"></a></dt> <dd><p>Returns a compacted form of the sketch, optionally sorting it</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_tuple_sketch.filter"> -<span class="sig-name descname"><span class="pre">filter</span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.filter" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">predicate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_tuple_sketch" title="_datasketches.compact_tuple_sketch"><span class="pre">_datasketches.compact_tuple_sketch</span></a></span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.filter" title="Link to this definition"></a></dt> <dd><p>Produces a compact_tuple_sketch from the given sketch by applying a predicate to the summary in each entry.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -278,21 +278,25 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_tuple_sketch.reset"> -<span class="sig-name descname"><span class="pre">reset</span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.reset" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.reset" title="Link to this definition"></a></dt> <dd><p>Resets the sketch to the initial empty state</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_tuple_sketch.trim"> -<span class="sig-name descname"><span class="pre">trim</span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.trim" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">trim</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.trim" title="Link to this definition"></a></dt> <dd><p>Removes retained entries in excess of the nominal size k (if any)</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.update_tuple_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.update_tuple_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">datum:</span> <span class="pre">int,</span> <span class="pre">value:</span> <span class="pre">object)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -312,7 +316,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.compact_tuple_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">compact_tuple_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.compact_tuple_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">compact_tuple_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.compact_tuple_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.compact_tuple_sketch.deserialize"> @@ -353,9 +357,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.compact_tuple_sketch.filter"> -<span class="sig-name descname"><span class="pre">filter</span></span><a class="headerlink" href="#datasketches.compact_tuple_sketch.filter" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">predicate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_tuple_sketch" title="_datasketches.compact_tuple_sketch"><span class="pre">_datasketches.compact_tuple_sketch</span></a></span></span><a class="headerlink" href="#datasketches.compact_tuple_sketch.filter" title="Link to this definition"></a></dt> <dd><p>Produces a compact_tuple_sketch from the given sketch by applying a predicate to the summary in each entry.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -370,9 +374,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.compact_tuple_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.compact_tuple_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.compact_tuple_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object</p> </dd></dl> @@ -380,7 +384,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.tuple_union"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tuple_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tuple_union" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">tuple_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tuple_union" title="Link to this definition"></a></dt> <dd><dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_union.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/tuple_policy.html#datasketches.TuplePolicy" title="_datasketches.TuplePolicy"><span class="pre">_datasketches.TuplePolicy</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">lg_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">12</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9001</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tuple_union.__init__" title="Link to this definition"></a></dt> @@ -397,21 +401,21 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_union.get_result"> -<span class="sig-name descname"><span class="pre">get_result</span></span><a class="headerlink" href="#datasketches.tuple_union.get_result" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_tuple_sketch" title="_datasketches.compact_tuple_sketch"><span class="pre">_datasketches.compact_tuple_sketch</span></a></span></span><a class="headerlink" href="#datasketches.tuple_union.get_result" title="Link to this definition"></a></dt> <dd><p>Returns the sketch corresponding to the union result</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_union.reset"> -<span class="sig-name descname"><span class="pre">reset</span></span><a class="headerlink" href="#datasketches.tuple_union.reset" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tuple_union.reset" title="Link to this definition"></a></dt> <dd><p>Resets the sketch to the initial empty</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_union.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.tuple_union.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.tuple_sketch" title="_datasketches.tuple_sketch"><span class="pre">_datasketches.tuple_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tuple_union.update" title="Link to this definition"></a></dt> <dd><p>Updates the union with the given sketch</p> </dd></dl> @@ -419,7 +423,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.tuple_intersection"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tuple_intersection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tuple_intersection" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">tuple_intersection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tuple_intersection" title="Link to this definition"></a></dt> <dd><dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_intersection.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/tuple_policy.html#datasketches.TuplePolicy" title="_datasketches.TuplePolicy"><span class="pre">_datasketches.TuplePolicy</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9001</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tuple_intersection.__init__" title="Link to this definition"></a></dt> @@ -434,21 +438,21 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_intersection.get_result"> -<span class="sig-name descname"><span class="pre">get_result</span></span><a class="headerlink" href="#datasketches.tuple_intersection.get_result" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_tuple_sketch" title="_datasketches.compact_tuple_sketch"><span class="pre">_datasketches.compact_tuple_sketch</span></a></span></span><a class="headerlink" href="#datasketches.tuple_intersection.get_result" title="Link to this definition"></a></dt> <dd><p>Returns the sketch corresponding to the intersection result</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_intersection.has_result"> -<span class="sig-name descname"><span class="pre">has_result</span></span><a class="headerlink" href="#datasketches.tuple_intersection.has_result" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">has_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.tuple_intersection.has_result" title="Link to this definition"></a></dt> <dd><p>Returns True if the intersection has a valid result, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_intersection.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.tuple_intersection.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.tuple_sketch" title="_datasketches.tuple_sketch"><span class="pre">_datasketches.tuple_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tuple_intersection.update" title="Link to this definition"></a></dt> <dd><p>Intersects the provided sketch with the current intersection state</p> </dd></dl> @@ -456,7 +460,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.tuple_a_not_b"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tuple_a_not_b</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tuple_a_not_b" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">tuple_a_not_b</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tuple_a_not_b" title="Link to this definition"></a></dt> <dd><dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_a_not_b.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9001</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tuple_a_not_b.__init__" title="Link to this definition"></a></dt> @@ -468,9 +472,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_a_not_b.compute"> -<span class="sig-name descname"><span class="pre">compute</span></span><a class="headerlink" href="#datasketches.tuple_a_not_b.compute" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">compute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">a</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.tuple_sketch" title="_datasketches.tuple_sketch"><span class="pre">_datasketches.tuple_sketch</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.tuple_sketch" title="_datasketches.tuple_sketch"><span class="pre">_datasketches.tuple_sketch</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.compact_tuple_sketch" title="_datasketches.compact_tuple_sketch"><span class="pre">_datasketches.compact_tuple_sketch</span></a></span></span><a class="headerlink" href="#datasketches.tuple_a_not_b.compute" title="Link to this definition"></a></dt> <dd><p>Returns a sketch with the result of applying the A-not-B operation on the given inputs</p> </dd></dl>
diff --git a/docs/main/frequency/count_min_sketch.html b/docs/main/frequency/count_min_sketch.html index 934d24d..cbd2746 100644 --- a/docs/main/frequency/count_min_sketch.html +++ b/docs/main/frequency/count_min_sketch.html
@@ -8,15 +8,15 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>CountMin Sketch — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> - <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> + <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -57,20 +57,20 @@ <li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.suggest_num_buckets"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.suggest_num_buckets()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.suggest_num_hashes"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.suggest_num_hashes()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_estimate</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_relative_error"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_relative_error</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_serialized_size_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.merge"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_estimate()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_relative_error"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_relative_error()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_serialized_size_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.get_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.merge"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.num_buckets"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.num_buckets</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.num_hashes"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.num_hashes</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.seed"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.seed</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.to_string</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.to_string()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.total_weight"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.total_weight</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.update"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.count_min_sketch.update"><code class="docutils literal notranslate"><span class="pre">count_min_sketch.update()</span></code></a></li> </ul> </li> </ul> @@ -126,7 +126,7 @@ heavy hitters.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.count_min_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">count_min_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.count_min_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">count_min_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.count_min_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.deserialize"> @@ -147,9 +147,11 @@ </dd></dl> <p class="rubric">Non-static Methods:</p> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.get_estimate"> -<span class="sig-name descname"><span class="pre">get_estimate</span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_estimate" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_estimate" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">get_estimate(self,</span> <span class="pre">item:</span> <span class="pre">int)</span> <span class="pre">-></span> <span class="pre">float</span></code></p></li> @@ -161,9 +163,11 @@ <p>Returns an estimate of the frequency of the provided string</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.get_lower_bound"> -<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_lower_bound" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">get_lower_bound(self,</span> <span class="pre">item:</span> <span class="pre">int)</span> <span class="pre">-></span> <span class="pre">float</span></code></p></li> @@ -175,21 +179,23 @@ <p>Returns a lower bound on the estimate for the provided string</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.get_relative_error"> -<span class="sig-name descname"><span class="pre">get_relative_error</span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_relative_error" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_relative_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_relative_error" title="Link to this definition"></a></dt> <dd><p>Returns the maximum permissible error for any frequency estimate query</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.get_serialized_size_bytes"> -<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> <dd><p>Returns the size in bytes of the serialized image of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.get_upper_bound"> -<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.get_upper_bound" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">get_upper_bound(self,</span> <span class="pre">item:</span> <span class="pre">int)</span> <span class="pre">-></span> <span class="pre">float</span></code></p></li> @@ -201,57 +207,59 @@ <p>Returns an upper bound on the estimate for the provided string</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.count_min_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch has seen no items, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.count_min_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.count_min_sketch" title="_datasketches.count_min_sketch"><span class="pre">_datasketches.count_min_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided other sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.num_buckets"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_buckets</span></span><a class="headerlink" href="#datasketches.count_min_sketch.num_buckets" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_buckets</span></span><a class="headerlink" href="#datasketches.count_min_sketch.num_buckets" title="Link to this definition"></a></dt> <dd><p>The configured number of buckets for the sketch</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.num_hashes"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_hashes</span></span><a class="headerlink" href="#datasketches.count_min_sketch.num_hashes" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_hashes</span></span><a class="headerlink" href="#datasketches.count_min_sketch.num_hashes" title="Link to this definition"></a></dt> <dd><p>The configured number of hashes for the sketch</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.seed"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">seed</span></span><a class="headerlink" href="#datasketches.count_min_sketch.seed" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">seed</span></span><a class="headerlink" href="#datasketches.count_min_sketch.seed" title="Link to this definition"></a></dt> <dd><p>The base hash seed for the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.count_min_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.count_min_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.total_weight"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">total_weight</span></span><a class="headerlink" href="#datasketches.count_min_sketch.total_weight" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">total_weight</span></span><a class="headerlink" href="#datasketches.count_min_sketch.total_weight" title="Link to this definition"></a></dt> <dd><p>The total weight currently inserted into the stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.count_min_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.count_min_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.count_min_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">int,</span> <span class="pre">weight:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li>
diff --git a/docs/main/frequency/frequent_items.html b/docs/main/frequency/frequent_items.html index 77da896..7ee2725 100644 --- a/docs/main/frequency/frequent_items.html +++ b/docs/main/frequency/frequent_items.html
@@ -8,15 +8,15 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Frequent Items — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> - <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> + <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -62,19 +62,19 @@ <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_epsilon_for_lg_size"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_epsilon_for_lg_size()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_apriori_error"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_apriori_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.__init__()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_estimate()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_frequent_items"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_frequent_items()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_serialized_size_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.merge"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.merge()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.update"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.update()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.epsilon"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.epsilon</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_estimate</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_frequent_items"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_frequent_items</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_serialized_size_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.get_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.merge"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.merge</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.num_active_items"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.num_active_items</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.to_string</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.total_weight"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.total_weight</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_items_sketch.update"><code class="docutils literal notranslate"><span class="pre">frequent_items_sketch.update</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.frequent_strings_sketch"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch</span></code></a><ul> @@ -82,19 +82,19 @@ <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_epsilon_for_lg_size"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_epsilon_for_lg_size()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_apriori_error"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_apriori_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.__init__()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_estimate()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_frequent_items"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_frequent_items()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_serialized_size_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.merge"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.merge()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.update"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.update()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.epsilon"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.epsilon</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_estimate</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_frequent_items"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_frequent_items</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_serialized_size_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.get_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.merge"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.merge</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.num_active_items"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.num_active_items</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.to_string</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.total_weight"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.total_weight</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.frequent_strings_sketch.update"><code class="docutils literal notranslate"><span class="pre">frequent_strings_sketch.update</span></code></a></li> </ul> </li> </ul> @@ -200,22 +200,22 @@ </div> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.frequent_items_error_type"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">frequent_items_error_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.frequent_items_error_type" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">frequent_items_error_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.frequent_items_error_type" title="Link to this definition"></a></dt> <dd><dl class="py attribute"> <dt class="sig sig-object py" id="datasketches.frequent_items_error_type.NO_FALSE_POSITIVES"> -<span class="sig-name descname"><span class="pre">NO_FALSE_POSITIVES</span></span><em class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">Returns</span> <span class="pre">only</span> <span class="pre">true</span> <span class="pre">positives</span> <span class="pre">but</span> <span class="pre">may</span> <span class="pre">miss</span> <span class="pre">some</span> <span class="pre">heavy</span> <span class="pre">hitters.</span></em><a class="headerlink" href="#datasketches.frequent_items_error_type.NO_FALSE_POSITIVES" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">NO_FALSE_POSITIVES</span></span><span class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">Returns</span> <span class="pre">only</span> <span class="pre">true</span> <span class="pre">positives</span> <span class="pre">but</span> <span class="pre">may</span> <span class="pre">miss</span> <span class="pre">some</span> <span class="pre">heavy</span> <span class="pre">hitters.</span></span><a class="headerlink" href="#datasketches.frequent_items_error_type.NO_FALSE_POSITIVES" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="datasketches.frequent_items_error_type.NO_FALSE_NEGATIVES"> -<span class="sig-name descname"><span class="pre">NO_FALSE_NEGATIVES</span></span><em class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">Does</span> <span class="pre">not</span> <span class="pre">miss</span> <span class="pre">any</span> <span class="pre">heavy</span> <span class="pre">hitters</span> <span class="pre">but</span> <span class="pre">may</span> <span class="pre">return</span> <span class="pre">false</span> <span class="pre">positives.</span></em><a class="headerlink" href="#datasketches.frequent_items_error_type.NO_FALSE_NEGATIVES" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">NO_FALSE_NEGATIVES</span></span><span class="property"><span class="w"> </span><span class="pre">:</span> <span class="pre">Does</span> <span class="pre">not</span> <span class="pre">miss</span> <span class="pre">any</span> <span class="pre">heavy</span> <span class="pre">hitters</span> <span class="pre">but</span> <span class="pre">may</span> <span class="pre">return</span> <span class="pre">false</span> <span class="pre">positives.</span></span><a class="headerlink" href="#datasketches.frequent_items_error_type.NO_FALSE_NEGATIVES" title="Link to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">frequent_items_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.frequent_items_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">frequent_items_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.frequent_items_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.deserialize"> @@ -247,89 +247,89 @@ </dl> </dd></dl> -<dl class="py property"> -<dt class="sig sig-object py" id="datasketches.frequent_items_sketch.epsilon"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">epsilon</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.epsilon" title="Link to this definition"></a></dt> -<dd><p>The epsilon value used by the sketch to compute error</p> -</dd></dl> - -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.get_estimate"> -<span class="sig-name descname"><span class="pre">get_estimate</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_estimate" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_estimate" title="Link to this definition"></a></dt> <dd><p>Returns the estimate of the weight (frequency) of the given item. Note: The true frequency of a item would be the sum of the counts as a result of the two update functions.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.get_frequent_items"> -<span class="sig-name descname"><span class="pre">get_frequent_items</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_frequent_items" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_frequent_items</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">err_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.frequent_items_error_type" title="_datasketches.frequent_items_error_type"><span class="pre">_datasketches.frequent_items_error_type</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_frequent_items" title="Link to this definition"></a></dt> <dd></dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.get_lower_bound"> -<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns the guaranteed lower bound weight (frequency) of the given item.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.get_serialized_size_bytes"> -<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> <dd><p>Computes the size needed to serialize the current state of the sketch using the provided serde. This can be expensive since every item needs to be looked at.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.get_upper_bound"> -<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.get_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns the guaranteed upper bound weight (frequency) of the given item.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.frequent_items_sketch" title="_datasketches.frequent_items_sketch"><span class="pre">_datasketches.frequent_items_sketch</span></a></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the given sketch into this one</p> </dd></dl> +<dl class="py method"> +<dt class="sig sig-object py" id="datasketches.frequent_items_sketch.serialize"> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.serialize" title="Link to this definition"></a></dt> +<dd><p>Serializes the sketch into a bytes object using the provided serde.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datasketches.frequent_items_sketch.to_string"> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.to_string" title="Link to this definition"></a></dt> +<dd><p>Produces a string summary of the sketch</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datasketches.frequent_items_sketch.update"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.update" title="Link to this definition"></a></dt> +<dd><p>Updates the sketch with the given string and, optionally, a weight</p> +</dd></dl> + +<dl class="py property"> +<dt class="sig sig-object py" id="datasketches.frequent_items_sketch.epsilon"> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">epsilon</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.epsilon" title="Link to this definition"></a></dt> +<dd><p>The epsilon value used by the sketch to compute error</p> +</dd></dl> + <dl class="py property"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.num_active_items"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_active_items</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.num_active_items" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_active_items</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.num_active_items" title="Link to this definition"></a></dt> <dd><p>The number of active items in the sketch</p> </dd></dl> -<dl class="py attribute"> -<dt class="sig sig-object py" id="datasketches.frequent_items_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.serialize" title="Link to this definition"></a></dt> -<dd><p>Serializes the sketch into a bytes object using the provided serde.</p> -</dd></dl> - -<dl class="py attribute"> -<dt class="sig sig-object py" id="datasketches.frequent_items_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.to_string" title="Link to this definition"></a></dt> -<dd><p>Produces a string summary of the sketch</p> -</dd></dl> - <dl class="py property"> <dt class="sig sig-object py" id="datasketches.frequent_items_sketch.total_weight"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">total_weight</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.total_weight" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">total_weight</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.total_weight" title="Link to this definition"></a></dt> <dd><p>The sum of the weights (frequencies) in the stream seen so far by the sketch</p> </dd></dl> -<dl class="py attribute"> -<dt class="sig sig-object py" id="datasketches.frequent_items_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.frequent_items_sketch.update" title="Link to this definition"></a></dt> -<dd><p>Updates the sketch with the given string and, optionally, a weight</p> -</dd></dl> - </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">frequent_strings_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.frequent_strings_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">frequent_strings_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.frequent_strings_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.deserialize"> @@ -361,84 +361,84 @@ </dl> </dd></dl> -<dl class="py property"> -<dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.epsilon"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">epsilon</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.epsilon" title="Link to this definition"></a></dt> -<dd><p>The epsilon value used by the sketch to compute error</p> -</dd></dl> - -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.get_estimate"> -<span class="sig-name descname"><span class="pre">get_estimate</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_estimate" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_estimate" title="Link to this definition"></a></dt> <dd><p>Returns the estimate of the weight (frequency) of the given item. Note: The true frequency of a item would be the sum of the counts as a result of the two update functions.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.get_frequent_items"> -<span class="sig-name descname"><span class="pre">get_frequent_items</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_frequent_items" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_frequent_items</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">err_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.frequent_items_error_type" title="_datasketches.frequent_items_error_type"><span class="pre">_datasketches.frequent_items_error_type</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_frequent_items" title="Link to this definition"></a></dt> <dd></dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.get_lower_bound"> -<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns the guaranteed lower bound weight (frequency) of the given item.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.get_serialized_size_bytes"> -<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> <dd><p>Computes the size needed to serialize the current state of the sketch. This can be expensive since every item needs to be looked at.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.get_upper_bound"> -<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.get_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns the guaranteed upper bound weight (frequency) of the given item.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.frequent_strings_sketch" title="_datasketches.frequent_strings_sketch"><span class="pre">_datasketches.frequent_strings_sketch</span></a></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the given sketch into this one</p> </dd></dl> +<dl class="py method"> +<dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.serialize"> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.serialize" title="Link to this definition"></a></dt> +<dd><p>Serializes the sketch into a bytes object.</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.to_string"> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.to_string" title="Link to this definition"></a></dt> +<dd><p>Produces a string summary of the sketch</p> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.update"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.update" title="Link to this definition"></a></dt> +<dd><p>Updates the sketch with the given string and, optionally, a weight</p> +</dd></dl> + +<dl class="py property"> +<dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.epsilon"> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">epsilon</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.epsilon" title="Link to this definition"></a></dt> +<dd><p>The epsilon value used by the sketch to compute error</p> +</dd></dl> + <dl class="py property"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.num_active_items"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_active_items</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.num_active_items" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_active_items</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.num_active_items" title="Link to this definition"></a></dt> <dd><p>The number of active items in the sketch</p> </dd></dl> -<dl class="py attribute"> -<dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.serialize" title="Link to this definition"></a></dt> -<dd><p>Serializes the sketch into a bytes object.</p> -</dd></dl> - -<dl class="py attribute"> -<dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.to_string" title="Link to this definition"></a></dt> -<dd><p>Produces a string summary of the sketch</p> -</dd></dl> - <dl class="py property"> <dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.total_weight"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">total_weight</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.total_weight" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">total_weight</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.total_weight" title="Link to this definition"></a></dt> <dd><p>The sum of the weights (frequencies) in the stream seen so far by the sketch</p> </dd></dl> -<dl class="py attribute"> -<dt class="sig sig-object py" id="datasketches.frequent_strings_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.frequent_strings_sketch.update" title="Link to this definition"></a></dt> -<dd><p>Updates the sketch with the given string and, optionally, a weight</p> -</dd></dl> - </dd></dl> </section>
diff --git a/docs/main/frequency/index.html b/docs/main/frequency/index.html index 1f38065..7ebc1d1 100644 --- a/docs/main/frequency/index.html +++ b/docs/main/frequency/index.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Frequency Sketches — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" />
diff --git a/docs/main/genindex.html b/docs/main/genindex.html index 8c4b453..bffdad1 100644 --- a/docs/main/genindex.html +++ b/docs/main/genindex.html
@@ -7,14 +7,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Index — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" /> <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=2709fde1"></script> - <script src="_static/doctools.js?v=9bcbadda"></script> - <script src="_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="_static/doctools.js?v=fd6eb6e6"></script> + <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="#" /> <link rel="search" title="Search" href="search.html" /> @@ -201,28 +201,28 @@ <td style="width: 33%; vertical-align: top;"><ul> <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.c">c (ebpps_sketch property)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.update_theta_sketch.compact">compact (update_theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.update_theta_sketch.compact">compact() (update_theta_sketch method)</a> <ul> - <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.compact">(update_tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.compact">(update_tuple_sketch method)</a> </li> </ul></li> <li><a href="distinct_counting/theta.html#datasketches.compact_theta_sketch">compact_theta_sketch (class in datasketches)</a> </li> <li><a href="distinct_counting/tuple.html#datasketches.compact_tuple_sketch">compact_tuple_sketch (class in datasketches)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.compress">compress (tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.compress">compress() (tdigest_double method)</a> <ul> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.compress">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.compress">(tdigest_float method)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="distinct_counting/theta.html#datasketches.theta_a_not_b.compute">compute (theta_a_not_b attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_a_not_b.compute">compute() (theta_a_not_b method)</a> <ul> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_a_not_b.compute">(tuple_a_not_b attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_a_not_b.compute">(tuple_a_not_b method)</a> </li> </ul></li> <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch">count_min_sketch (class in _datasketches)</a> @@ -319,7 +319,7 @@ </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.estimate_subset_sum">estimate_subset_sum (var_opt_sketch attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.estimate_subset_sum">estimate_subset_sum() (var_opt_sketch method)</a> </li> <li><a href="helper/jaccard.html#datasketches.theta_jaccard_similarity.exactly_equal">exactly_equal() (theta_jaccard_similarity method)</a> @@ -333,10 +333,10 @@ <h2 id="F">F</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="distinct_counting/tuple.html#datasketches.compact_tuple_sketch.filter">filter (compact_tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.compact_tuple_sketch.filter">filter() (compact_tuple_sketch method)</a> <ul> - <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.filter">(update_tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.filter">(update_tuple_sketch method)</a> </li> </ul></li> <li><a href="frequency/frequent_items.html#datasketches.frequent_items_error_type">frequent_items_error_type (class in datasketches)</a> @@ -363,35 +363,35 @@ <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_apriori_error">(frequent_strings_sketch method)</a> </li> </ul></li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_cdf">get_cdf (kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_cdf">get_cdf() (kll_doubles_sketch method)</a> <ul> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_cdf">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_cdf">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_cdf">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_cdf">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_cdf">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_cdf">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_cdf">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_cdf">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_cdf">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_cdf">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_cdf">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_cdf">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_cdf">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_cdf">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_cdf">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_cdf">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_cdf">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_cdf">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_cdf">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_cdf">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_cdf">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_cdf">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_cdf">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_cdf">(tdigest_float method)</a> </li> </ul></li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_compact_serialization_bytes">get_compact_serialization_bytes (hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_compact_serialization_bytes">get_compact_serialization_bytes() (hll_sketch method)</a> </li> <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_epsilon_for_lg_size">get_epsilon_for_lg_size() (frequent_items_sketch method)</a> @@ -399,106 +399,106 @@ <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_epsilon_for_lg_size">(frequent_strings_sketch method)</a> </li> </ul></li> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_estimate">get_estimate (count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_estimate">get_estimate() (count_min_sketch method)</a> <ul> - <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.get_estimate">(cpc_sketch attribute)</a> + <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.get_estimate">(cpc_sketch method)</a> </li> - <li><a href="vector/density_sketch.html#datasketches.density_sketch.get_estimate">(density_sketch attribute)</a> + <li><a href="vector/density_sketch.html#datasketches.density_sketch.get_estimate">(density_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_estimate">(frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_estimate">(frequent_items_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_estimate">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_estimate">(frequent_strings_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_estimate">(hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_estimate">(hll_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.get_estimate">(hll_union attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.get_estimate">(hll_union method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.get_estimate">(theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.get_estimate">(theta_sketch method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.get_estimate">(tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.get_estimate">(tuple_sketch method)</a> </li> </ul></li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_frequent_items">get_frequent_items (frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_frequent_items">get_frequent_items() (frequent_items_sketch method)</a> <ul> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_frequent_items">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_frequent_items">(frequent_strings_sketch method)</a> </li> </ul></li> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_lower_bound">get_lower_bound (count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_lower_bound">get_lower_bound() (count_min_sketch method)</a> <ul> - <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.get_lower_bound">(cpc_sketch attribute)</a> + <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.get_lower_bound">(cpc_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_lower_bound">(frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_lower_bound">(frequent_items_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_lower_bound">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_lower_bound">(frequent_strings_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_lower_bound">(hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_lower_bound">(hll_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.get_lower_bound">(hll_union attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.get_lower_bound">(hll_union method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.get_lower_bound">(theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.get_lower_bound">(theta_sketch method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.get_lower_bound">(tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.get_lower_bound">(tuple_sketch method)</a> </li> </ul></li> <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_max_updatable_serialization_bytes">get_max_updatable_serialization_bytes() (hll_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_max_value">get_max_value (kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_max_value">get_max_value() (kll_doubles_sketch method)</a> <ul> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_max_value">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_max_value">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_max_value">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_max_value">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_max_value">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_max_value">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_max_value">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_max_value">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_max_value">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_max_value">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_max_value">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_max_value">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_max_value">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_max_value">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_max_value">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_max_value">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_max_value">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_max_value">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_max_value">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_max_value">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_max_value">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_max_value">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_max_value">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_max_value">(tdigest_float method)</a> </li> </ul></li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_min_value">get_min_value (kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_min_value">get_min_value() (kll_doubles_sketch method)</a> <ul> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_min_value">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_min_value">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_min_value">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_min_value">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_min_value">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_min_value">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_min_value">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_min_value">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_min_value">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_min_value">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_min_value">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_min_value">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_min_value">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_min_value">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_min_value">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_min_value">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_min_value">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_min_value">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_min_value">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_min_value">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_min_value">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_min_value">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_min_value">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_min_value">(tdigest_float method)</a> </li> </ul></li> <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_normalized_rank_error">get_normalized_rank_error() (kll_doubles_sketch method)</a> @@ -519,130 +519,130 @@ <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_normalized_rank_error">(quantiles_items_sketch method)</a> </li> </ul></li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_pmf">get_pmf (kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_pmf">get_pmf() (kll_doubles_sketch method)</a> <ul> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_pmf">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_pmf">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_pmf">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_pmf">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_pmf">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_pmf">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_pmf">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_pmf">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_pmf">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_pmf">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_pmf">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_pmf">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_pmf">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_pmf">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_pmf">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_pmf">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_pmf">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_pmf">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_pmf">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_pmf">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_pmf">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_pmf">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_pmf">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_pmf">(tdigest_float method)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_quantile">get_quantile (kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_quantile">get_quantile() (kll_doubles_sketch method)</a> <ul> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_quantile">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_quantile">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_quantile">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_quantile">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_quantile">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_quantile">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_quantile">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_quantile">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_quantile">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_quantile">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_quantile">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_quantile">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_quantile">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_quantile">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_quantile">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_quantile">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_quantile">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_quantile">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_quantile">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_quantile">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_quantile">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_quantile">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_quantile">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_quantile">(tdigest_float method)</a> </li> </ul></li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_quantiles">get_quantiles (kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_quantiles">get_quantiles() (kll_doubles_sketch method)</a> <ul> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_quantiles">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_quantiles">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_quantiles">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_quantiles">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_quantiles">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_quantiles">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_quantiles">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_quantiles">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_quantiles">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_quantiles">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_quantiles">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_quantiles">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_quantiles">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_quantiles">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_quantiles">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_quantiles">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_quantiles">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_quantiles">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_quantiles">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_quantiles">(req_items_sketch method)</a> </li> </ul></li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_rank">get_rank (kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.get_rank">get_rank() (kll_doubles_sketch method)</a> <ul> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_rank">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.get_rank">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_rank">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.get_rank">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_rank">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.get_rank">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_rank">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.get_rank">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_rank">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.get_rank">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_rank">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.get_rank">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_rank">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.get_rank">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_rank">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_rank">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_rank">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_rank">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_rank">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_rank">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_rank">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_rank">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_rank">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_rank">(tdigest_float method)</a> </li> </ul></li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_rank_lower_bound">get_rank_lower_bound (req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_rank_lower_bound">get_rank_lower_bound() (req_floats_sketch method)</a> <ul> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_rank_lower_bound">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_rank_lower_bound">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_rank_lower_bound">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_rank_lower_bound">(req_items_sketch method)</a> </li> </ul></li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_rank_upper_bound">get_rank_upper_bound (req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_rank_upper_bound">get_rank_upper_bound() (req_floats_sketch method)</a> <ul> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_rank_upper_bound">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.get_rank_upper_bound">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_rank_upper_bound">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_rank_upper_bound">(req_items_sketch method)</a> </li> </ul></li> <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_rel_err">get_rel_err() (hll_sketch method)</a> @@ -651,22 +651,22 @@ <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.get_rel_err">(hll_union method)</a> </li> </ul></li> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_relative_error">get_relative_error (count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_relative_error">get_relative_error() (count_min_sketch method)</a> </li> - <li><a href="distinct_counting/cpc.html#datasketches.cpc_union.get_result">get_result (cpc_union attribute)</a> + <li><a href="distinct_counting/cpc.html#datasketches.cpc_union.get_result">get_result() (cpc_union method)</a> <ul> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.get_result">(hll_union attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.get_result">(hll_union method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_intersection.get_result">(theta_intersection attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_intersection.get_result">(theta_intersection method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_union.get_result">(theta_union attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_union.get_result">(theta_union method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_intersection.get_result">(tuple_intersection attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_intersection.get_result">(tuple_intersection method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_union.get_result">(tuple_union attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_union.get_result">(tuple_union method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_union.get_result">(var_opt_union attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_union.get_result">(var_opt_union method)</a> </li> </ul></li> <li><a href="quantiles/req.html#datasketches.req_floats_sketch.get_RSE">get_RSE() (req_floats_sketch method)</a> @@ -677,56 +677,56 @@ <li><a href="quantiles/req.html#datasketches.req_items_sketch.get_RSE">(req_items_sketch method)</a> </li> </ul></li> - <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.get_seed_hash">get_seed_hash (theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.get_seed_hash">get_seed_hash() (theta_sketch method)</a> <ul> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.get_seed_hash">(tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.get_seed_hash">(tuple_sketch method)</a> </li> </ul></li> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_serialized_size_bytes">get_serialized_size_bytes (count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_serialized_size_bytes">get_serialized_size_bytes() (count_min_sketch method)</a> <ul> - <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.get_serialized_size_bytes">(ebpps_sketch attribute)</a> + <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.get_serialized_size_bytes">(ebpps_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_serialized_size_bytes">(frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_serialized_size_bytes">(frequent_items_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_serialized_size_bytes">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_serialized_size_bytes">(frequent_strings_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_serialized_size_bytes">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_serialized_size_bytes">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_serialized_size_bytes">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_serialized_size_bytes">(tdigest_float method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.get_serialized_size_bytes">(var_opt_sketch attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.get_serialized_size_bytes">(var_opt_sketch method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_union.get_serialized_size_bytes">(var_opt_union attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_union.get_serialized_size_bytes">(var_opt_union method)</a> </li> </ul></li> <li><a href="helper/serde.html#datasketches.PyObjectSerDe.get_size">get_size() (PyObjectSerDe method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_total_weight">get_total_weight (tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.get_total_weight">get_total_weight() (tdigest_double method)</a> <ul> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_total_weight">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.get_total_weight">(tdigest_float method)</a> </li> </ul></li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_updatable_serialization_bytes">get_updatable_serialization_bytes (hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_updatable_serialization_bytes">get_updatable_serialization_bytes() (hll_sketch method)</a> </li> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_upper_bound">get_upper_bound (count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.get_upper_bound">get_upper_bound() (count_min_sketch method)</a> <ul> - <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.get_upper_bound">(cpc_sketch attribute)</a> + <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.get_upper_bound">(cpc_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_upper_bound">(frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.get_upper_bound">(frequent_items_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_upper_bound">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.get_upper_bound">(frequent_strings_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_upper_bound">(hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.get_upper_bound">(hll_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.get_upper_bound">(hll_union attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.get_upper_bound">(hll_union method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.get_upper_bound">(theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.get_upper_bound">(theta_sketch method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.get_upper_bound">(tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.get_upper_bound">(tuple_sketch method)</a> </li> </ul></li> </ul></td> @@ -735,10 +735,10 @@ <h2 id="H">H</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="distinct_counting/theta.html#datasketches.theta_intersection.has_result">has_result (theta_intersection attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_intersection.has_result">has_result() (theta_intersection method)</a> <ul> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_intersection.has_result">(tuple_intersection attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_intersection.has_result">(tuple_intersection method)</a> </li> </ul></li> <li><a href="distinct_counting/hyper_log_log.html#datasketches.tgt_hll_type.HLL_4">HLL_4 (tgt_hll_type attribute)</a> @@ -759,102 +759,102 @@ <h2 id="I">I</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.is_compact">is_compact (hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.is_compact">is_compact() (hll_sketch method)</a> </li> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.is_empty">is_empty (count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.is_empty">is_empty() (count_min_sketch method)</a> <ul> - <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.is_empty">(cpc_sketch attribute)</a> + <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.is_empty">(cpc_sketch method)</a> </li> - <li><a href="vector/density_sketch.html#datasketches.density_sketch.is_empty">(density_sketch attribute)</a> + <li><a href="vector/density_sketch.html#datasketches.density_sketch.is_empty">(density_sketch method)</a> </li> - <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.is_empty">(ebpps_sketch attribute)</a> + <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.is_empty">(ebpps_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.is_empty">(frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.is_empty">(frequent_items_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.is_empty">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.is_empty">(frequent_strings_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.is_empty">(hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.is_empty">(hll_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.is_empty">(hll_union attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.is_empty">(hll_union method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.is_empty">(kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.is_empty">(kll_doubles_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.is_empty">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.is_empty">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.is_empty">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.is_empty">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.is_empty">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.is_empty">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.is_empty">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.is_empty">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.is_empty">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.is_empty">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.is_empty">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.is_empty">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.is_empty">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.is_empty">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.is_empty">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.is_empty">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.is_empty">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.is_empty">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.is_empty">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.is_empty">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.is_empty">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.is_empty">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.is_empty">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.is_empty">(tdigest_float method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.is_empty">(theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.is_empty">(theta_sketch method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.is_empty">(tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.is_empty">(tuple_sketch method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.is_empty">(var_opt_sketch attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.is_empty">(var_opt_sketch method)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="vector/density_sketch.html#datasketches.density_sketch.is_estimation_mode">is_estimation_mode (density_sketch attribute)</a> + <li><a href="vector/density_sketch.html#datasketches.density_sketch.is_estimation_mode">is_estimation_mode() (density_sketch method)</a> <ul> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.is_estimation_mode">(kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.is_estimation_mode">(kll_doubles_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.is_estimation_mode">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.is_estimation_mode">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.is_estimation_mode">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.is_estimation_mode">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.is_estimation_mode">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.is_estimation_mode">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.is_estimation_mode">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.is_estimation_mode">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.is_estimation_mode">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.is_estimation_mode">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.is_estimation_mode">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.is_estimation_mode">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.is_estimation_mode">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.is_estimation_mode">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.is_estimation_mode">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.is_estimation_mode">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.is_estimation_mode">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.is_estimation_mode">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.is_estimation_mode">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.is_estimation_mode">(req_items_sketch method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.is_estimation_mode">(theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.is_estimation_mode">(theta_sketch method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.is_estimation_mode">(tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.is_estimation_mode">(tuple_sketch method)</a> </li> </ul></li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.is_hra">is_hra (req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.is_hra">is_hra() (req_floats_sketch method)</a> <ul> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.is_hra">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.is_hra">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.is_hra">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.is_hra">(req_items_sketch method)</a> </li> </ul></li> - <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.is_ordered">is_ordered (theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.is_ordered">is_ordered() (theta_sketch method)</a> <ul> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.is_ordered">(tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.is_ordered">(tuple_sketch method)</a> </li> </ul></li> </ul></td> @@ -947,42 +947,42 @@ <td style="width: 33%; vertical-align: top;"><ul> <li><a href="helper/tuple_policy.html#datasketches.MaxIntPolicy">MaxIntPolicy (class in datasketches)</a> </li> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.merge">merge (count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.merge">merge() (count_min_sketch method)</a> <ul> - <li><a href="vector/density_sketch.html#datasketches.density_sketch.merge">(density_sketch attribute)</a> + <li><a href="vector/density_sketch.html#datasketches.density_sketch.merge">(density_sketch method)</a> </li> - <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.merge">(ebpps_sketch attribute)</a> + <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.merge">(ebpps_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.merge">(frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.merge">(frequent_items_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.merge">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.merge">(frequent_strings_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.merge">(kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.merge">(kll_doubles_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.merge">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.merge">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.merge">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.merge">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.merge">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.merge">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.merge">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.merge">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.merge">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.merge">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.merge">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.merge">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.merge">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.merge">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.merge">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.merge">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.merge">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.merge">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.merge">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.merge">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.merge">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.merge">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.merge">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.merge">(tdigest_float method)</a> </li> </ul></li> </ul></td> @@ -1029,22 +1029,22 @@ </li> <li><a href="frequency/frequent_items.html#datasketches.frequent_items_error_type.NO_FALSE_POSITIVES">NO_FALSE_POSITIVES (frequent_items_error_type attribute)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.normalized_rank_error">normalized_rank_error (kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.normalized_rank_error">normalized_rank_error() (kll_doubles_sketch method)</a> <ul> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.normalized_rank_error">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.normalized_rank_error">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.normalized_rank_error">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.normalized_rank_error">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.normalized_rank_error">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.normalized_rank_error">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.normalized_rank_error">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.normalized_rank_error">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.normalized_rank_error">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.normalized_rank_error">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.normalized_rank_error">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.normalized_rank_error">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.normalized_rank_error">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.normalized_rank_error">(quantiles_items_sketch method)</a> </li> </ul></li> </ul></td> @@ -1139,18 +1139,18 @@ </li> <li><a href="quantiles/req.html#datasketches.req_items_sketch">req_items_sketch (class in datasketches)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.reset">reset (hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.reset">reset() (hll_sketch method)</a> <ul> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.reset">(hll_union attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.reset">(hll_union method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_union.reset">(tuple_union attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_union.reset">(tuple_union method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.update_theta_sketch.reset">(update_theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.update_theta_sketch.reset">(update_theta_sketch method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.reset">(update_tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.reset">(update_tuple_sketch method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_union.reset">(var_opt_union attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_union.reset">(var_opt_union method)</a> </li> </ul></li> </ul></td> @@ -1161,59 +1161,59 @@ <td style="width: 33%; vertical-align: top;"><ul> <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.seed">seed (count_min_sketch property)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.compact_theta_sketch.serialize">serialize (compact_theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.compact_theta_sketch.serialize">serialize() (compact_theta_sketch method)</a> <ul> - <li><a href="distinct_counting/tuple.html#datasketches.compact_tuple_sketch.serialize">(compact_tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.compact_tuple_sketch.serialize">(compact_tuple_sketch method)</a> </li> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.serialize">(count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.serialize">(count_min_sketch method)</a> </li> - <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.serialize">(cpc_sketch attribute)</a> + <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.serialize">(cpc_sketch method)</a> </li> - <li><a href="vector/density_sketch.html#datasketches.density_sketch.serialize">(density_sketch attribute)</a> + <li><a href="vector/density_sketch.html#datasketches.density_sketch.serialize">(density_sketch method)</a> </li> - <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.serialize">(ebpps_sketch attribute)</a> + <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.serialize">(ebpps_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.serialize">(frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.serialize">(frequent_items_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.serialize">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.serialize">(frequent_strings_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.serialize">(kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.serialize">(kll_doubles_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.serialize">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.serialize">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.serialize">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.serialize">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.serialize">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.serialize">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.serialize">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.serialize">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.serialize">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.serialize">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.serialize">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.serialize">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.serialize">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.serialize">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.serialize">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.serialize">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.serialize">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.serialize">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.serialize">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.serialize">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.serialize">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.serialize">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.serialize">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.serialize">(tdigest_float method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.serialize">(var_opt_sketch attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.serialize">(var_opt_sketch method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_union.serialize">(var_opt_union attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_union.serialize">(var_opt_union method)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.serialize_compact">serialize_compact (hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.serialize_compact">serialize_compact() (hll_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.serialize_updatable">serialize_updatable (hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.serialize_updatable">serialize_updatable() (hll_sketch method)</a> </li> <li><a href="helper/jaccard.html#datasketches.theta_jaccard_similarity.similarity_test">similarity_test() (theta_jaccard_similarity method)</a> @@ -1263,54 +1263,54 @@ </li> <li><a href="helper/serde.html#datasketches.PyObjectSerDe.to_bytes">to_bytes() (PyObjectSerDe method)</a> </li> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.to_string">to_string (count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.to_string">to_string() (count_min_sketch method)</a> <ul> - <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.to_string">(cpc_sketch attribute)</a> + <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.to_string">(cpc_sketch method)</a> </li> - <li><a href="vector/density_sketch.html#datasketches.density_sketch.to_string">(density_sketch attribute)</a> + <li><a href="vector/density_sketch.html#datasketches.density_sketch.to_string">(density_sketch method)</a> </li> - <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.to_string">(ebpps_sketch attribute)</a> + <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.to_string">(ebpps_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.to_string">(frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.to_string">(frequent_items_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.to_string">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.to_string">(frequent_strings_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.to_string">(hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.to_string">(hll_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.to_string">(kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.to_string">(kll_doubles_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.to_string">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.to_string">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.to_string">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.to_string">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.to_string">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.to_string">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.to_string">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.to_string">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.to_string">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.to_string">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.to_string">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.to_string">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.to_string">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.to_string">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.to_string">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.to_string">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.to_string">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.to_string">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.to_string">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.to_string">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.to_string">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.to_string">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.to_string">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.to_string">(tdigest_float method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.to_string">(theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_sketch.to_string">(theta_sketch method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.to_string">(tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_sketch.to_string">(tuple_sketch method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.to_string">(var_opt_sketch attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.to_string">(var_opt_sketch method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_union.to_string">(var_opt_union attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_union.to_string">(var_opt_union method)</a> </li> </ul></li> </ul></td> @@ -1323,10 +1323,10 @@ <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.total_weight">(frequent_strings_sketch property)</a> </li> </ul></li> - <li><a href="distinct_counting/theta.html#datasketches.update_theta_sketch.trim">trim (update_theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.update_theta_sketch.trim">trim() (update_theta_sketch method)</a> <ul> - <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.trim">(update_tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.trim">(update_tuple_sketch method)</a> </li> </ul></li> <li><a href="distinct_counting/tuple.html#datasketches.tuple_a_not_b">tuple_a_not_b (class in datasketches)</a> @@ -1347,66 +1347,66 @@ <h2 id="U">U</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.update">update (count_min_sketch attribute)</a> + <li><a href="frequency/count_min_sketch.html#datasketches.count_min_sketch.update">update() (count_min_sketch method)</a> <ul> - <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.update">(cpc_sketch attribute)</a> + <li><a href="distinct_counting/cpc.html#datasketches.cpc_sketch.update">(cpc_sketch method)</a> </li> - <li><a href="distinct_counting/cpc.html#datasketches.cpc_union.update">(cpc_union attribute)</a> + <li><a href="distinct_counting/cpc.html#datasketches.cpc_union.update">(cpc_union method)</a> </li> - <li><a href="vector/density_sketch.html#datasketches.density_sketch.update">(density_sketch attribute)</a> + <li><a href="vector/density_sketch.html#datasketches.density_sketch.update">(density_sketch method)</a> </li> - <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.update">(ebpps_sketch attribute)</a> + <li><a href="sampling/ebpps.html#datasketches.ebpps_sketch.update">(ebpps_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.update">(frequent_items_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_items_sketch.update">(frequent_items_sketch method)</a> </li> - <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.update">(frequent_strings_sketch attribute)</a> + <li><a href="frequency/frequent_items.html#datasketches.frequent_strings_sketch.update">(frequent_strings_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.update">(hll_sketch attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_sketch.update">(hll_sketch method)</a> </li> - <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.update">(hll_union attribute)</a> + <li><a href="distinct_counting/hyper_log_log.html#datasketches.hll_union.update">(hll_union method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.update">(kll_doubles_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_doubles_sketch.update">(kll_doubles_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.update">(kll_floats_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_floats_sketch.update">(kll_floats_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.update">(kll_ints_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_ints_sketch.update">(kll_ints_sketch method)</a> </li> - <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.update">(kll_items_sketch attribute)</a> + <li><a href="quantiles/kll.html#datasketches.kll_items_sketch.update">(kll_items_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.update">(quantiles_doubles_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_doubles_sketch.update">(quantiles_doubles_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.update">(quantiles_floats_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_floats_sketch.update">(quantiles_floats_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.update">(quantiles_ints_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_ints_sketch.update">(quantiles_ints_sketch method)</a> </li> - <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.update">(quantiles_items_sketch attribute)</a> + <li><a href="quantiles/quantiles_depr.html#datasketches.quantiles_items_sketch.update">(quantiles_items_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_floats_sketch.update">(req_floats_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_floats_sketch.update">(req_floats_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_ints_sketch.update">(req_ints_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_ints_sketch.update">(req_ints_sketch method)</a> </li> - <li><a href="quantiles/req.html#datasketches.req_items_sketch.update">(req_items_sketch attribute)</a> + <li><a href="quantiles/req.html#datasketches.req_items_sketch.update">(req_items_sketch method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.update">(tdigest_double attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_double.update">(tdigest_double method)</a> </li> - <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.update">(tdigest_float attribute)</a> + <li><a href="quantiles/tdigest.html#datasketches.tdigest_float.update">(tdigest_float method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_intersection.update">(theta_intersection attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_intersection.update">(theta_intersection method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.theta_union.update">(theta_union attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.theta_union.update">(theta_union method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_intersection.update">(tuple_intersection attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_intersection.update">(tuple_intersection method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.tuple_union.update">(tuple_union attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.tuple_union.update">(tuple_union method)</a> </li> - <li><a href="distinct_counting/theta.html#datasketches.update_theta_sketch.update">(update_theta_sketch attribute)</a> + <li><a href="distinct_counting/theta.html#datasketches.update_theta_sketch.update">(update_theta_sketch method)</a> </li> - <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.update">(update_tuple_sketch attribute)</a> + <li><a href="distinct_counting/tuple.html#datasketches.update_tuple_sketch.update">(update_tuple_sketch method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.update">(var_opt_sketch attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_sketch.update">(var_opt_sketch method)</a> </li> - <li><a href="sampling/varopt.html#datasketches.var_opt_union.update">(var_opt_union attribute)</a> + <li><a href="sampling/varopt.html#datasketches.var_opt_union.update">(var_opt_union method)</a> </li> </ul></li> </ul></td>
diff --git a/docs/main/helper/index.html b/docs/main/helper/index.html index dc74ac3..d73d7a2 100644 --- a/docs/main/helper/index.html +++ b/docs/main/helper/index.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Helper Classes — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" />
diff --git a/docs/main/helper/jaccard.html b/docs/main/helper/jaccard.html index d36838a..adb625a 100644 --- a/docs/main/helper/jaccard.html +++ b/docs/main/helper/jaccard.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Jaccard Similarity — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -116,7 +116,7 @@ <p>Note that there are separate classes to be used for theta and tuple sketches.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.theta_jaccard_similarity"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">theta_jaccard_similarity</span></span><a class="headerlink" href="#datasketches.theta_jaccard_similarity" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">theta_jaccard_similarity</span></span><a class="headerlink" href="#datasketches.theta_jaccard_similarity" title="Link to this definition"></a></dt> <dd><p>An object to help compute Jaccard similarity between theta sketches.</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.theta_jaccard_similarity.jaccard"> @@ -146,7 +146,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.tuple_jaccard_similarity"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tuple_jaccard_similarity</span></span><a class="headerlink" href="#datasketches.tuple_jaccard_similarity" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">tuple_jaccard_similarity</span></span><a class="headerlink" href="#datasketches.tuple_jaccard_similarity" title="Link to this definition"></a></dt> <dd><p>An object to help compute Jaccard similarity between tuple sketches.</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.tuple_jaccard_similarity.jaccard">
diff --git a/docs/main/helper/kernel.html b/docs/main/helper/kernel.html index f3a8af8..de68afa 100644 --- a/docs/main/helper/kernel.html +++ b/docs/main/helper/kernel.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Kernel Function — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -111,7 +111,7 @@ and provide a floating point value as a score indicating the similarity of two input vectors.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.KernelFunction"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">KernelFunction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.KernelFunction" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">KernelFunction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.KernelFunction" title="Link to this definition"></a></dt> <dd><p>A generic base class from which user-defined kernels must inherit.</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.KernelFunction.__call__"> @@ -137,7 +137,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.GaussianKernel"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GaussianKernel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bandwidth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.GaussianKernel" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">GaussianKernel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bandwidth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.GaussianKernel" title="Link to this definition"></a></dt> <dd><p>Bases: <a class="reference internal" href="#datasketches.KernelFunction" title="_datasketches.KernelFunction"><code class="xref py py-class docutils literal notranslate"><span class="pre">KernelFunction</span></code></a></p> <p>Implements a basic Gaussian kernel</p> <dl class="field-list simple">
diff --git a/docs/main/helper/ks_test.html b/docs/main/helper/ks_test.html index 598de34..602517d 100644 --- a/docs/main/helper/ks_test.html +++ b/docs/main/helper/ks_test.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Kolmogorov-Smirnov Test — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" />
diff --git a/docs/main/helper/serde.html b/docs/main/helper/serde.html index 95cfd2e..18f3de0 100644 --- a/docs/main/helper/serde.html +++ b/docs/main/helper/serde.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Serialize/Deserialize (SerDe) — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -114,7 +114,7 @@ <p>Each implementation must extend the <a class="reference internal" href="#datasketches.PyObjectSerDe" title="datasketches.PyObjectSerDe"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyObjectSerDe</span></code></a> class and override all three of its methods.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.PyObjectSerDe"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PyObjectSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyObjectSerDe" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">PyObjectSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyObjectSerDe" title="Link to this definition"></a></dt> <dd><p>An abstract base class for serde objects. All custom serdes must extend this class.</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.PyObjectSerDe.get_size"> @@ -175,7 +175,7 @@ <p>The provided SerDes are:</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.PyStringsSerDe"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PyStringsSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyStringsSerDe" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">PyStringsSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyStringsSerDe" title="Link to this definition"></a></dt> <dd><p>Bases: <a class="reference internal" href="#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyObjectSerDe</span></code></a></p> <p>Implements a simple string-encoding scheme where a string is written as <cite><num_bytes> <string_contents></cite>, with no null termination. @@ -186,7 +186,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.PyIntsSerDe"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PyIntsSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyIntsSerDe" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">PyIntsSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyIntsSerDe" title="Link to this definition"></a></dt> <dd><p>Bases: <a class="reference internal" href="#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyObjectSerDe</span></code></a></p> <p>Implements an integer encoding scheme where each integer is written as a 32-bit (4 byte) little-endian value.</p> @@ -194,7 +194,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.PyLongsSerDe"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PyLongsSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyLongsSerDe" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">PyLongsSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyLongsSerDe" title="Link to this definition"></a></dt> <dd><p>Bases: <a class="reference internal" href="#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyObjectSerDe</span></code></a></p> <p>Implements an integer encoding scheme where each integer is written as a 64-bit (8 byte) little-endian value.</p> @@ -202,7 +202,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.PyFloatsSerDe"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PyFloatsSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyFloatsSerDe" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">PyFloatsSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyFloatsSerDe" title="Link to this definition"></a></dt> <dd><p>Bases: <a class="reference internal" href="#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyObjectSerDe</span></code></a></p> <p>Implements a floating point encoding scheme where each value is written as a 32-bit floating point value.</p> @@ -210,7 +210,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.PyDoublesSerDe"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PyDoublesSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyDoublesSerDe" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">PyDoublesSerDe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.PyDoublesSerDe" title="Link to this definition"></a></dt> <dd><p>Implements a floating point encoding scheme where each value is written as a 64-bit floating point value.</p> </dd></dl>
diff --git a/docs/main/helper/tuple_policy.html b/docs/main/helper/tuple_policy.html index f1e065b..6c38daf 100644 --- a/docs/main/helper/tuple_policy.html +++ b/docs/main/helper/tuple_policy.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Tuple Policy — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -112,7 +112,7 @@ <p>Each implementation must extend the abstract base class <a class="reference internal" href="#datasketches.TuplePolicy" title="datasketches.TuplePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">TuplePolicy</span></code></a>.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.TuplePolicy"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">TuplePolicy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.TuplePolicy" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">TuplePolicy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.TuplePolicy" title="Link to this definition"></a></dt> <dd><p>An abstract base class for Tuple Policy objects. All custom policies must extend this class.</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.TuplePolicy.create_summary"> @@ -172,7 +172,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.AccumulatorPolicy"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AccumulatorPolicy</span></span><a class="headerlink" href="#datasketches.AccumulatorPolicy" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">AccumulatorPolicy</span></span><a class="headerlink" href="#datasketches.AccumulatorPolicy" title="Link to this definition"></a></dt> <dd><p>Bases: <a class="reference internal" href="#datasketches.TuplePolicy" title="_datasketches.TuplePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">TuplePolicy</span></code></a></p> <p>Implements an accumulatory summary policy, where new values are added to the existing value.</p> @@ -180,14 +180,14 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.MinIntPolicy"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MinIntPolicy</span></span><a class="headerlink" href="#datasketches.MinIntPolicy" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">MinIntPolicy</span></span><a class="headerlink" href="#datasketches.MinIntPolicy" title="Link to this definition"></a></dt> <dd><p>Bases: <a class="reference internal" href="#datasketches.TuplePolicy" title="_datasketches.TuplePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">TuplePolicy</span></code></a></p> <p>Implements a MIN rule, where the smallest integer value is always kept.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.MaxIntPolicy"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MaxIntPolicy</span></span><a class="headerlink" href="#datasketches.MaxIntPolicy" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">MaxIntPolicy</span></span><a class="headerlink" href="#datasketches.MaxIntPolicy" title="Link to this definition"></a></dt> <dd><p>Bases: <a class="reference internal" href="#datasketches.TuplePolicy" title="_datasketches.TuplePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">TuplePolicy</span></code></a></p> <p>Implements a MAX rule, where the largest integer value is always kept.</p> </dd></dl>
diff --git a/docs/main/index.html b/docs/main/index.html index df3fafa..3af29c9 100644 --- a/docs/main/index.html +++ b/docs/main/index.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Apache DataSketches — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" /> <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=2709fde1"></script> - <script src="_static/doctools.js?v=9bcbadda"></script> - <script src="_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="_static/doctools.js?v=fd6eb6e6"></script> + <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" />
diff --git a/docs/main/objects.inv b/docs/main/objects.inv index 4e57db7..5458476 100644 --- a/docs/main/objects.inv +++ b/docs/main/objects.inv Binary files differ
diff --git a/docs/main/quantiles/index.html b/docs/main/quantiles/index.html index c94ed2e..9cfb9b4 100644 --- a/docs/main/quantiles/index.html +++ b/docs/main/quantiles/index.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Quantiles Sketches — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" />
diff --git a/docs/main/quantiles/kll.html b/docs/main/quantiles/kll.html index d8867ed..02e6480 100644 --- a/docs/main/quantiles/kll.html +++ b/docs/main/quantiles/kll.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>KLL Sketch — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -52,92 +52,92 @@ <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.is_estimation_mode</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.is_estimation_mode()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.k"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.merge"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.merge"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.n"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.n</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.normalized_rank_error</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.update"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_ints_sketch.update"><code class="docutils literal notranslate"><span class="pre">kll_ints_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.kll_floats_sketch"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.is_estimation_mode</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.is_estimation_mode()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.k"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.merge"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.merge"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.n"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.n</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.normalized_rank_error</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.update"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_floats_sketch.update"><code class="docutils literal notranslate"><span class="pre">kll_floats_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.kll_doubles_sketch"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.is_estimation_mode</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.is_estimation_mode()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.k"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.merge"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.merge"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.n"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.n</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.normalized_rank_error</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.update"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_doubles_sketch.update"><code class="docutils literal notranslate"><span class="pre">kll_doubles_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.kll_items_sketch"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.is_estimation_mode</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.is_estimation_mode()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.k"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.merge"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.merge"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.n"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.n</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.normalized_rank_error</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.update"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.kll_items_sketch.update"><code class="docutils literal notranslate"><span class="pre">kll_items_sketch.update()</span></code></a></li> </ul> </li> </ul> @@ -282,7 +282,7 @@ </div> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">kll_ints_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.kll_ints_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">kll_ints_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.kll_ints_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.deserialize"> @@ -311,9 +311,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -323,21 +323,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, kll_floats_sketch returns nan; kll_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, kll_floats_sketch returns nan; kll_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -347,62 +347,62 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given normalized rank in a hypothetical sorted version of the input stream so far. For kll_floats_sketch: if the sketch is empty this returns nan. For kll_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.kll_ints_sketch" title="_datasketches.kll_ints_sketch"><span class="pre">_datasketches.kll_ints_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.normalized_rank_error"> -<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.normalized_rank_error" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_pmf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.normalized_rank_error" title="Link to this definition"></a></dt> <dd><p>Gets the normalized rank error for this sketch. If pmf is True, returns the ‘double-sided’ normalized rank error for the get_PMF() function. Otherwise, it is the ‘single-sided’ normalized rank error for all the other queries. @@ -411,25 +411,27 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_ints_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.kll_ints_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=int32]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">int)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -445,7 +447,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">kll_floats_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.kll_floats_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">kll_floats_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.kll_floats_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.deserialize"> @@ -474,9 +476,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -486,21 +488,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, kll_floats_sketch returns nan; kll_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, kll_floats_sketch returns nan; kll_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -510,62 +512,62 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given normalized rank in a hypothetical sorted version of the input stream so far. For kll_floats_sketch: if the sketch is empty this returns nan. For kll_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.kll_floats_sketch" title="_datasketches.kll_floats_sketch"><span class="pre">_datasketches.kll_floats_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.normalized_rank_error"> -<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.normalized_rank_error" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_pmf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.normalized_rank_error" title="Link to this definition"></a></dt> <dd><p>Gets the normalized rank error for this sketch. If pmf is True, returns the ‘double-sided’ normalized rank error for the get_PMF() function. Otherwise, it is the ‘single-sided’ normalized rank error for all the other queries. @@ -574,25 +576,27 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_floats_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.kll_floats_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=float32]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">float)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -608,7 +612,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">kll_doubles_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.kll_doubles_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">kll_doubles_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.kll_doubles_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.deserialize"> @@ -637,9 +641,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -649,21 +653,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, kll_floats_sketch returns nan; kll_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, kll_floats_sketch returns nan; kll_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -673,62 +677,62 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given normalized rank in a hypothetical sorted version of the input stream so far. For kll_floats_sketch: if the sketch is empty this returns nan. For kll_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.kll_doubles_sketch" title="_datasketches.kll_doubles_sketch"><span class="pre">_datasketches.kll_doubles_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.normalized_rank_error"> -<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.normalized_rank_error" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_pmf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.normalized_rank_error" title="Link to this definition"></a></dt> <dd><p>Gets the normalized rank error for this sketch. If pmf is True, returns the ‘double-sided’ normalized rank error for the get_PMF() function. Otherwise, it is the ‘single-sided’ normalized rank error for all the other queries. @@ -737,25 +741,27 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_doubles_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.kll_doubles_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=float64]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">float)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -771,7 +777,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">kll_items_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.kll_items_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">kll_items_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.kll_items_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.deserialize"> @@ -800,9 +806,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -812,21 +818,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, kll_floats_sketch returns nan; kll_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, kll_floats_sketch returns nan; kll_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -836,62 +842,62 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given normalized rank in a hypothetical sorted version of the input stream so far. For kll_floats_sketch: if the sketch is empty this returns nan. For kll_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.kll_items_sketch" title="_datasketches.kll_items_sketch"><span class="pre">_datasketches.kll_items_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.normalized_rank_error"> -<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.normalized_rank_error" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_pmf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.normalized_rank_error" title="Link to this definition"></a></dt> <dd><p>Gets the normalized rank error for this sketch. If pmf is True, returns the ‘double-sided’ normalized rank error for the get_PMF() function. Otherwise, it is the ‘single-sided’ normalized rank error for all the other queries. @@ -900,25 +906,25 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object using the provided serde.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.kll_items_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.kll_items_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.kll_items_sketch.update" title="Link to this definition"></a></dt> <dd><p>Updates the sketch with the given value</p> </dd></dl>
diff --git a/docs/main/quantiles/quantiles_depr.html b/docs/main/quantiles/quantiles_depr.html index 9b5605e..ee2a77c 100644 --- a/docs/main/quantiles/quantiles_depr.html +++ b/docs/main/quantiles/quantiles_depr.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Quantiles Sketch (Deprecated) — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -55,92 +55,92 @@ <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.is_estimation_mode</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.is_estimation_mode()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.k"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.merge"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.merge"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.n"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.n</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.normalized_rank_error</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.update"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_ints_sketch.update"><code class="docutils literal notranslate"><span class="pre">quantiles_ints_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.quantiles_floats_sketch"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.is_estimation_mode</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.is_estimation_mode()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.k"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.merge"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.merge"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.n"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.n</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.normalized_rank_error</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.update"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_floats_sketch.update"><code class="docutils literal notranslate"><span class="pre">quantiles_floats_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.is_estimation_mode</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.is_estimation_mode()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.k"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.merge"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.merge"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.n"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.n</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.normalized_rank_error</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.update"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch.update"><code class="docutils literal notranslate"><span class="pre">quantiles_doubles_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.quantiles_items_sketch"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.is_estimation_mode</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.is_estimation_mode()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.k"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.merge"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.merge"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.n"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.n</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.normalized_rank_error</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.normalized_rank_error"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.normalized_rank_error()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.update"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.quantiles_items_sketch.update"><code class="docutils literal notranslate"><span class="pre">quantiles_items_sketch.update()</span></code></a></li> </ul> </li> </ul> @@ -232,7 +232,7 @@ </div> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">quantiles_ints_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.quantiles_ints_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">quantiles_ints_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.quantiles_ints_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.deserialize"> @@ -261,9 +261,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -272,21 +272,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, quantiles_floats_sketch returns nan; quantiles_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, quantiles_floats_sketch returns nan; quantiles_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -295,62 +295,62 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given rank in a hypothetical sorted version of the input stream so far. For quantiles_floats_sketch: if the sketch is empty this returns nan. For quantiles_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.quantiles_ints_sketch" title="_datasketches.quantiles_ints_sketch"><span class="pre">_datasketches.quantiles_ints_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.normalized_rank_error"> -<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.normalized_rank_error" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_pmf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.normalized_rank_error" title="Link to this definition"></a></dt> <dd><p>Gets the normalized rank error for this sketch. If pmf is True, returns the ‘double-sided’ normalized rank error for the get_PMF() function. Otherwise, it is the ‘single-sided’ normalized rank error for all the other queries. @@ -359,25 +359,27 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_ints_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.quantiles_ints_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=int32]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">int)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -393,7 +395,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">quantiles_floats_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.quantiles_floats_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">quantiles_floats_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.quantiles_floats_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.deserialize"> @@ -422,9 +424,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -433,21 +435,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, quantiles_floats_sketch returns nan; quantiles_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, quantiles_floats_sketch returns nan; quantiles_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -456,62 +458,62 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given rank in a hypothetical sorted version of the input stream so far. For quantiles_floats_sketch: if the sketch is empty this returns nan. For quantiles_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.quantiles_floats_sketch" title="_datasketches.quantiles_floats_sketch"><span class="pre">_datasketches.quantiles_floats_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.normalized_rank_error"> -<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.normalized_rank_error" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_pmf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.normalized_rank_error" title="Link to this definition"></a></dt> <dd><p>Gets the normalized rank error for this sketch. If pmf is True, returns the ‘double-sided’ normalized rank error for the get_PMF() function. Otherwise, it is the ‘single-sided’ normalized rank error for all the other queries. @@ -520,25 +522,27 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_floats_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.quantiles_floats_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=float32]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">float)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -554,7 +558,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">quantiles_doubles_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">quantiles_doubles_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.deserialize"> @@ -583,9 +587,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -594,21 +598,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, quantiles_floats_sketch returns nan; quantiles_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, quantiles_floats_sketch returns nan; quantiles_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -617,62 +621,62 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given rank in a hypothetical sorted version of the input stream so far. For quantiles_floats_sketch: if the sketch is empty this returns nan. For quantiles_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.quantiles_doubles_sketch" title="_datasketches.quantiles_doubles_sketch"><span class="pre">_datasketches.quantiles_doubles_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.normalized_rank_error"> -<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.normalized_rank_error" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_pmf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.normalized_rank_error" title="Link to this definition"></a></dt> <dd><p>Gets the normalized rank error for this sketch. If pmf is True, returns the ‘double-sided’ normalized rank error for the get_PMF() function. Otherwise, it is the ‘single-sided’ normalized rank error for all the other queries. @@ -681,25 +685,27 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_doubles_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.quantiles_doubles_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=float64]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">float)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -715,7 +721,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">quantiles_items_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.quantiles_items_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">quantiles_items_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.quantiles_items_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.deserialize"> @@ -744,9 +750,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -755,21 +761,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, quantiles_floats_sketch returns nan; quantiles_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, quantiles_floats_sketch returns nan; quantiles_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -778,62 +784,62 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given rank in a hypothetical sorted version of the input stream so far. For quantiles_floats_sketch: if the sketch is empty this returns nan. For quantiles_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.quantiles_items_sketch" title="_datasketches.quantiles_items_sketch"><span class="pre">_datasketches.quantiles_items_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.normalized_rank_error"> -<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.normalized_rank_error" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">normalized_rank_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_pmf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.normalized_rank_error" title="Link to this definition"></a></dt> <dd><p>Gets the normalized rank error for this sketch. If pmf is True, returns the ‘double-sided’ normalized rank error for the get_PMF() function. Otherwise, it is the ‘single-sided’ normalized rank error for all the other queries. @@ -842,25 +848,25 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object using the provided serde.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.quantiles_items_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.quantiles_items_sketch.update" title="Link to this definition"></a></dt> <dd><p>Updates the sketch with the given value</p> </dd></dl>
diff --git a/docs/main/quantiles/req.html b/docs/main/quantiles/req.html index c81e563..002f5d8 100644 --- a/docs/main/quantiles/req.html +++ b/docs/main/quantiles/req.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Relative Error Quantiles (REQ) Sketch — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -53,75 +53,75 @@ <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_RSE"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_RSE()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_rank_lower_bound"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_rank_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_rank_upper_bound"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_rank_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.is_estimation_mode</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.is_hra"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.is_hra</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_rank_lower_bound"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_rank_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.get_rank_upper_bound"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.get_rank_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.is_estimation_mode()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.is_hra"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.is_hra()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.k"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.merge"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.merge"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.n"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.n</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.update"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_ints_sketch.update"><code class="docutils literal notranslate"><span class="pre">req_ints_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.req_floats_sketch"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_RSE"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_RSE()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_rank_lower_bound"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_rank_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_rank_upper_bound"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_rank_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.is_estimation_mode</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.is_hra"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.is_hra</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_rank_lower_bound"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_rank_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.get_rank_upper_bound"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.get_rank_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.is_estimation_mode()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.is_hra"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.is_hra()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.k"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.merge"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.merge"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.n"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.n</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.update"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_floats_sketch.update"><code class="docutils literal notranslate"><span class="pre">req_floats_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.req_items_sketch"><code class="docutils literal notranslate"><span class="pre">req_items_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_RSE"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_RSE()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_quantiles</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_rank_lower_bound"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_rank_lower_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_rank_upper_bound"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_rank_upper_bound</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.is_estimation_mode</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.is_hra"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.is_hra</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_cdf"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_max_value"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_min_value"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_pmf"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_quantile"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_quantiles"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_quantiles()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_rank"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_rank_lower_bound"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_rank_lower_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.get_rank_upper_bound"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.get_rank_upper_bound()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.is_estimation_mode()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.is_hra"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.is_hra()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.k"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.merge"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.merge"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.n"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.n</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.update"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.req_items_sketch.update"><code class="docutils literal notranslate"><span class="pre">req_items_sketch.update()</span></code></a></li> </ul> </li> </ul> @@ -202,7 +202,7 @@ </div> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">req_ints_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.req_ints_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">req_ints_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.req_ints_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.deserialize"> @@ -232,9 +232,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -244,21 +244,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, req_floats_sketch returns nan; req_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, req_floats_sketch returns nan; req_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -268,100 +268,102 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given normalized rank in a hypothetical sorted version of the input stream so far. For req_floats_sketch: if the sketch is empty this returns nan. For req_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.get_rank_lower_bound"> -<span class="sig-name descname"><span class="pre">get_rank_lower_bound</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_rank_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_dev</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_rank_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate lower bound on the given normalized rank. Normalized rank must be a value between 0.0 and 1.0 (inclusive); the number of standard deviations must be 1, 2, or 3.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.get_rank_upper_bound"> -<span class="sig-name descname"><span class="pre">get_rank_upper_bound</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_rank_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_dev</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.get_rank_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate upper bound on the given normalized rank. Normalized rank must be a value between 0.0 and 1.0 (inclusive); the number of standard deviations must be 1, 2, or 3.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.is_hra"> -<span class="sig-name descname"><span class="pre">is_hra</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.is_hra" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_hra</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.is_hra" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in High Rank Accuracy mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.req_ints_sketch" title="_datasketches.req_ints_sketch"><span class="pre">_datasketches.req_ints_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_ints_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.req_ints_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.req_ints_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=int32]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">int)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -377,7 +379,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">req_floats_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.req_floats_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">req_floats_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.req_floats_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.deserialize"> @@ -407,9 +409,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -419,21 +421,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, req_floats_sketch returns nan; req_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, req_floats_sketch returns nan; req_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -443,100 +445,102 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given normalized rank in a hypothetical sorted version of the input stream so far. For req_floats_sketch: if the sketch is empty this returns nan. For req_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.get_rank_lower_bound"> -<span class="sig-name descname"><span class="pre">get_rank_lower_bound</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_rank_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_dev</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_rank_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate lower bound on the given normalized rank. Normalized rank must be a value between 0.0 and 1.0 (inclusive); the number of standard deviations must be 1, 2, or 3.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.get_rank_upper_bound"> -<span class="sig-name descname"><span class="pre">get_rank_upper_bound</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_rank_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_dev</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.get_rank_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate upper bound on the given normalized rank. Normalized rank must be a value between 0.0 and 1.0 (inclusive); the number of standard deviations must be 1, 2, or 3.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.is_hra"> -<span class="sig-name descname"><span class="pre">is_hra</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.is_hra" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_hra</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.is_hra" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in High Rank Accuracy mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.req_floats_sketch" title="_datasketches.req_floats_sketch"><span class="pre">_datasketches.req_floats_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_floats_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.req_floats_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.req_floats_sketch.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=float32]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">float)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -552,7 +556,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.req_items_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">req_items_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.req_items_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">req_items_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.req_items_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.deserialize"> @@ -582,9 +586,9 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -594,21 +598,21 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, req_floats_sketch returns nan; req_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, req_floats_sketch returns nan; req_ints_sketch throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). The resulting approximations have a probabilistic guarantee that can be obtained from the get_normalized_rank_error(True) function. If the sketch is empty this returns an empty vector. @@ -618,100 +622,100 @@ It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given normalized rank in a hypothetical sorted version of the input stream so far. For req_floats_sketch: if the sketch is empty this returns nan. For req_ints_sketch: if the sketch is empty this throws a RuntimeError.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.get_quantiles"> -<span class="sig-name descname"><span class="pre">get_quantiles</span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_quantiles" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ranks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_quantiles" title="Link to this definition"></a></dt> <dd><p>This returns an array that could have been generated by using get_quantile() for each normalized rank separately. If the sketch is empty this returns an empty vector.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inclusive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_rank" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the normalized rank of the given value from 0 to 1, inclusive. The resulting approximation has a probabilistic guarantee that can be obtained from the get_normalized_rank_error(False) function. With the parameter inclusive=true the weight of the given value is included into the rank.Otherwise the rank equals the sum of the weights of values less than the given value. If the sketch is empty this returns nan.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.get_rank_lower_bound"> -<span class="sig-name descname"><span class="pre">get_rank_lower_bound</span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_rank_lower_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_dev</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_rank_lower_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate lower bound on the given normalized rank. Normalized rank must be a value between 0.0 and 1.0 (inclusive); the number of standard deviations must be 1, 2, or 3.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.get_rank_upper_bound"> -<span class="sig-name descname"><span class="pre">get_rank_upper_bound</span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_rank_upper_bound" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_dev</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.get_rank_upper_bound" title="Link to this definition"></a></dt> <dd><p>Returns an approximate upper bound on the given normalized rank. Normalized rank must be a value between 0.0 and 1.0 (inclusive); the number of standard deviations must be 1, 2, or 3.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.req_items_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.req_items_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.is_hra"> -<span class="sig-name descname"><span class="pre">is_hra</span></span><a class="headerlink" href="#datasketches.req_items_sketch.is_hra" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_hra</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.is_hra" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in High Rank Accuracy mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.req_items_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.req_items_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.req_items_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.req_items_sketch" title="_datasketches.req_items_sketch"><span class="pre">_datasketches.req_items_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.req_items_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.req_items_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.req_items_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.req_items_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.req_items_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object using the provided serde.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.req_items_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.req_items_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.req_items_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.req_items_sketch.update" title="Link to this definition"></a></dt> <dd><p>Updates the sketch with the given value</p> </dd></dl>
diff --git a/docs/main/quantiles/tdigest.html b/docs/main/quantiles/tdigest.html index dde4f4b..85b4635 100644 --- a/docs/main/quantiles/tdigest.html +++ b/docs/main/quantiles/tdigest.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>t-digest — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -53,41 +53,41 @@ <li class="toctree-l3"><a class="reference internal" href="#datasketches.tdigest_float"><code class="docutils literal notranslate"><span class="pre">tdigest_float</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.deserialize"><code class="docutils literal notranslate"><span class="pre">tdigest_float.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.__init__"><code class="docutils literal notranslate"><span class="pre">tdigest_float.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.compress"><code class="docutils literal notranslate"><span class="pre">tdigest_float.compress</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_cdf"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_max_value"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_min_value"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_pmf"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_quantile"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_rank"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_serialized_size_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_total_weight"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_total_weight</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.is_empty"><code class="docutils literal notranslate"><span class="pre">tdigest_float.is_empty</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.compress"><code class="docutils literal notranslate"><span class="pre">tdigest_float.compress()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_cdf"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_max_value"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_min_value"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_pmf"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_quantile"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_rank"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_serialized_size_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.get_total_weight"><code class="docutils literal notranslate"><span class="pre">tdigest_float.get_total_weight()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.is_empty"><code class="docutils literal notranslate"><span class="pre">tdigest_float.is_empty()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.k"><code class="docutils literal notranslate"><span class="pre">tdigest_float.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.merge"><code class="docutils literal notranslate"><span class="pre">tdigest_float.merge</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.serialize"><code class="docutils literal notranslate"><span class="pre">tdigest_float.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.to_string"><code class="docutils literal notranslate"><span class="pre">tdigest_float.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.update"><code class="docutils literal notranslate"><span class="pre">tdigest_float.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.merge"><code class="docutils literal notranslate"><span class="pre">tdigest_float.merge()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.serialize"><code class="docutils literal notranslate"><span class="pre">tdigest_float.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.to_string"><code class="docutils literal notranslate"><span class="pre">tdigest_float.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_float.update"><code class="docutils literal notranslate"><span class="pre">tdigest_float.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.tdigest_double"><code class="docutils literal notranslate"><span class="pre">tdigest_double</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.deserialize"><code class="docutils literal notranslate"><span class="pre">tdigest_double.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.__init__"><code class="docutils literal notranslate"><span class="pre">tdigest_double.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.compress"><code class="docutils literal notranslate"><span class="pre">tdigest_double.compress</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_cdf"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_cdf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_max_value"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_max_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_min_value"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_min_value</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_pmf"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_pmf</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_quantile"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_quantile</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_rank"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_rank</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_serialized_size_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_total_weight"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_total_weight</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.is_empty"><code class="docutils literal notranslate"><span class="pre">tdigest_double.is_empty</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.compress"><code class="docutils literal notranslate"><span class="pre">tdigest_double.compress()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_cdf"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_cdf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_max_value"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_max_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_min_value"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_min_value()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_pmf"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_pmf()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_quantile"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_quantile()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_rank"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_rank()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_serialized_size_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.get_total_weight"><code class="docutils literal notranslate"><span class="pre">tdigest_double.get_total_weight()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.is_empty"><code class="docutils literal notranslate"><span class="pre">tdigest_double.is_empty()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.k"><code class="docutils literal notranslate"><span class="pre">tdigest_double.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.merge"><code class="docutils literal notranslate"><span class="pre">tdigest_double.merge</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.serialize"><code class="docutils literal notranslate"><span class="pre">tdigest_double.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.to_string"><code class="docutils literal notranslate"><span class="pre">tdigest_double.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.update"><code class="docutils literal notranslate"><span class="pre">tdigest_double.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.merge"><code class="docutils literal notranslate"><span class="pre">tdigest_double.merge()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.serialize"><code class="docutils literal notranslate"><span class="pre">tdigest_double.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.to_string"><code class="docutils literal notranslate"><span class="pre">tdigest_double.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.tdigest_double.update"><code class="docutils literal notranslate"><span class="pre">tdigest_double.update()</span></code></a></li> </ul> </li> </ul> @@ -155,7 +155,7 @@ <p>For more information on the performance characteristics, see <a class="reference external" href="https://datasketches.apache.org/docs/tdigest/tdigest.html">the Datasketches page on t-digest</a>.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.tdigest_float"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tdigest_float</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tdigest_float" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">tdigest_float</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tdigest_float" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.deserialize"> @@ -175,99 +175,101 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.compress"> -<span class="sig-name descname"><span class="pre">compress</span></span><a class="headerlink" href="#datasketches.tdigest_float.compress" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">compress</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.compress" title="Link to this definition"></a></dt> <dd><p>Process buffered values and merge centroids, if necesssary</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.tdigest_float.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.tdigest_float.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). If the sketch is empty this returns an empty vector. split_points is an array of m unique, monotonically increasing float values that divide the real number line into m+1 consecutive disjoint intervals. It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.tdigest_float.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.tdigest_float.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.tdigest_float.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.tdigest_float.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). If the sketch is empty this returns an empty vector. split_points is an array of m unique, monotonically increasing float values that divide the real number line into m+1 consecutive disjoint intervals. It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.tdigest_float.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given rank in a hypothetical sorted version of the input stream so far.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.tdigest_float.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.get_rank" title="Link to this definition"></a></dt> <dd><p>Computes the approximate normalized rank of the given value</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.get_serialized_size_bytes"> -<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><a class="headerlink" href="#datasketches.tdigest_float.get_serialized_size_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_buffer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.get_serialized_size_bytes" title="Link to this definition"></a></dt> <dd><p>Returns the size of the serialized sketch, in bytes</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.get_total_weight"> -<span class="sig-name descname"><span class="pre">get_total_weight</span></span><a class="headerlink" href="#datasketches.tdigest_float.get_total_weight" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_total_weight</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.get_total_weight" title="Link to this definition"></a></dt> <dd><p>The total weight processed by the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.tdigest_float.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.tdigest_float.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.tdigest_float.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.tdigest_float.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.tdigest_float.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.tdigest_float" title="_datasketches.tdigest_float"><span class="pre">_datasketches.tdigest_float</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.tdigest_float.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.tdigest_float.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_centroids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_float.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.tdigest_float.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tdigest_float.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=float32]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">float)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li> @@ -283,7 +285,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.tdigest_double"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tdigest_double</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tdigest_double" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">tdigest_double</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.tdigest_double" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.deserialize"> @@ -303,99 +305,101 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.compress"> -<span class="sig-name descname"><span class="pre">compress</span></span><a class="headerlink" href="#datasketches.tdigest_double.compress" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">compress</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.compress" title="Link to this definition"></a></dt> <dd><p>Process buffered values and merge centroids, if necesssary</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.get_cdf"> -<span class="sig-name descname"><span class="pre">get_cdf</span></span><a class="headerlink" href="#datasketches.tdigest_double.get_cdf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_cdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.tdigest_double.get_cdf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Cumulative Distribution Function (CDF), which is the cumulative analog of the PMF, of the input stream given a set of split points (values). If the sketch is empty this returns an empty vector. split_points is an array of m unique, monotonically increasing float values that divide the real number line into m+1 consecutive disjoint intervals. It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.get_max_value"> -<span class="sig-name descname"><span class="pre">get_max_value</span></span><a class="headerlink" href="#datasketches.tdigest_double.get_max_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_max_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.get_max_value" title="Link to this definition"></a></dt> <dd><p>Returns the maximum value from the stream. If empty, throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.get_min_value"> -<span class="sig-name descname"><span class="pre">get_min_value</span></span><a class="headerlink" href="#datasketches.tdigest_double.get_min_value" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_min_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.get_min_value" title="Link to this definition"></a></dt> <dd><p>Returns the minimum value from the stream. If empty, throws a RuntimeError</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.get_pmf"> -<span class="sig-name descname"><span class="pre">get_pmf</span></span><a class="headerlink" href="#datasketches.tdigest_double.get_pmf" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_pmf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datasketches.tdigest_double.get_pmf" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the Probability Mass Function (PMF) of the input stream given a set of split points (values). If the sketch is empty this returns an empty vector. split_points is an array of m unique, monotonically increasing float values that divide the real number line into m+1 consecutive disjoint intervals. It is not necessary to include either the min or max values in these split points.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.get_quantile"> -<span class="sig-name descname"><span class="pre">get_quantile</span></span><a class="headerlink" href="#datasketches.tdigest_double.get_quantile" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_quantile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rank</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.get_quantile" title="Link to this definition"></a></dt> <dd><p>Returns an approximation to the data value associated with the given rank in a hypothetical sorted version of the input stream so far.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.get_rank"> -<span class="sig-name descname"><span class="pre">get_rank</span></span><a class="headerlink" href="#datasketches.tdigest_double.get_rank" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_rank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.get_rank" title="Link to this definition"></a></dt> <dd><p>Computes the approximate normalized rank of the given value</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.get_serialized_size_bytes"> -<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><a class="headerlink" href="#datasketches.tdigest_double.get_serialized_size_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_buffer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.get_serialized_size_bytes" title="Link to this definition"></a></dt> <dd><p>Returns the size of the serialized sketch, in bytes</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.get_total_weight"> -<span class="sig-name descname"><span class="pre">get_total_weight</span></span><a class="headerlink" href="#datasketches.tdigest_double.get_total_weight" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_total_weight</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.get_total_weight" title="Link to this definition"></a></dt> <dd><p>The total weight processed by the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.tdigest_double.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.tdigest_double.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.tdigest_double.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.tdigest_double.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.tdigest_double.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.tdigest_double" title="_datasketches.tdigest_double"><span class="pre">_datasketches.tdigest_double</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.tdigest_double.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.tdigest_double.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_centroids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.tdigest_double.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.tdigest_double.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.tdigest_double.update" title="Link to this definition"></a></dt> +<dt class="sig sig-object py"> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">self,</span> <span class="pre">array:</span> <span class="pre">ndarray[dtype=float64]</span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span></dt> <dd><p>Overloaded function.</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">update(self,</span> <span class="pre">item:</span> <span class="pre">float)</span> <span class="pre">-></span> <span class="pre">None</span></code></p></li>
diff --git a/docs/main/sampling/ebpps.html b/docs/main/sampling/ebpps.html index 8702d12..bb5d9be 100644 --- a/docs/main/sampling/ebpps.html +++ b/docs/main/sampling/ebpps.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Exact and Bounded, Probabilitiy Proportional to Size (EBPPS) Sampling — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -62,14 +62,14 @@ <li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.__init__()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.c"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.c</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.get_serialized_size_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.is_empty</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.get_serialized_size_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.is_empty()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.k"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.merge"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.merge"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.n"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.n</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.update"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.ebpps_sketch.update"><code class="docutils literal notranslate"><span class="pre">ebpps_sketch.update()</span></code></a></li> </ul> </li> </ul> @@ -124,7 +124,7 @@ </div> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ebpps_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.ebpps_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">ebpps_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.ebpps_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.deserialize"> @@ -146,55 +146,55 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.c"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">c</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.c" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">c</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.c" title="Link to this definition"></a></dt> <dd><p>The expected number of samples returned upon a call to get_result() or the creation of an iterator. The number is a floating point value, where the fractional portion represents the probability of including a “partial item” from the sample. The value C should be no larger than the sketch’s configured value of k, although numerical precision limitations mean it may exceed k by double precision floating point error margins in certain cases.</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.get_serialized_size_bytes"> -<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.ebpps_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> <dd><p>Computes the size in bytes needed to serialize the current sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.ebpps_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.k" title="Link to this definition"></a></dt> <dd><p>The sketch’s maximum configured sample size</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.ebpps_sketch" title="_datasketches.ebpps_sketch"><span class="pre">_datasketches.ebpps_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.ebpps_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the sketch with the given sketch</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.n" title="Link to this definition"></a></dt> <dd><p>The total stream length</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.ebpps_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.ebpps_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch and optionally prints the items</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.ebpps_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.ebpps_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.ebpps_sketch.update" title="Link to this definition"></a></dt> <dd><p>Updates the sketch with the given value and weight</p> </dd></dl>
diff --git a/docs/main/sampling/index.html b/docs/main/sampling/index.html index 8bb6435..47d5bb2 100644 --- a/docs/main/sampling/index.html +++ b/docs/main/sampling/index.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Random Sampling Sketches — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" />
diff --git a/docs/main/sampling/varopt.html b/docs/main/sampling/varopt.html index 6a98836..f03bd7a 100644 --- a/docs/main/sampling/varopt.html +++ b/docs/main/sampling/varopt.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Variance Optimal Sampling (VarOpt) — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -60,26 +60,26 @@ <li class="toctree-l3"><a class="reference internal" href="#datasketches.var_opt_sketch"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.estimate_subset_sum"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.estimate_subset_sum</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.get_serialized_size_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.is_empty</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.estimate_subset_sum"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.estimate_subset_sum()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.get_serialized_size_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.is_empty()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.k"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.k</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.n"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.n</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.num_samples"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.num_samples</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.update"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_sketch.update"><code class="docutils literal notranslate"><span class="pre">var_opt_sketch.update()</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#datasketches.var_opt_union"><code class="docutils literal notranslate"><span class="pre">var_opt_union</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.deserialize"><code class="docutils literal notranslate"><span class="pre">var_opt_union.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.__init__"><code class="docutils literal notranslate"><span class="pre">var_opt_union.__init__()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.get_result"><code class="docutils literal notranslate"><span class="pre">var_opt_union.get_result</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">var_opt_union.get_serialized_size_bytes</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.reset"><code class="docutils literal notranslate"><span class="pre">var_opt_union.reset</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.serialize"><code class="docutils literal notranslate"><span class="pre">var_opt_union.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.to_string"><code class="docutils literal notranslate"><span class="pre">var_opt_union.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.update"><code class="docutils literal notranslate"><span class="pre">var_opt_union.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.get_result"><code class="docutils literal notranslate"><span class="pre">var_opt_union.get_result()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.get_serialized_size_bytes"><code class="docutils literal notranslate"><span class="pre">var_opt_union.get_serialized_size_bytes()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.reset"><code class="docutils literal notranslate"><span class="pre">var_opt_union.reset()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.serialize"><code class="docutils literal notranslate"><span class="pre">var_opt_union.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.to_string"><code class="docutils literal notranslate"><span class="pre">var_opt_union.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.var_opt_union.update"><code class="docutils literal notranslate"><span class="pre">var_opt_union.update()</span></code></a></li> </ul> </li> </ul> @@ -132,7 +132,7 @@ </div> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">var_opt_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.var_opt_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">var_opt_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.var_opt_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.deserialize"> @@ -152,57 +152,57 @@ </dl> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.estimate_subset_sum"> -<span class="sig-name descname"><span class="pre">estimate_subset_sum</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.estimate_subset_sum" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">estimate_subset_sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">predicate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#datasketches.var_opt_sketch.estimate_subset_sum" title="Link to this definition"></a></dt> <dd><p>Applies a provided predicate to the sketch and returns the estimated total weight matching the predicate, as well as upper and lower bounds on the estimate and the total weight processed by the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.get_serialized_size_bytes"> -<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.var_opt_sketch.get_serialized_size_bytes" title="Link to this definition"></a></dt> <dd><p>Computes the size in bytes needed to serialize the current sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.var_opt_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.k" title="Link to this definition"></a></dt> <dd><p>Returns the sketch’s maximum configured sample size</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.n" title="Link to this definition"></a></dt> <dd><p>Returns the total stream length</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.num_samples"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_samples</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.num_samples" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_samples</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.num_samples" title="Link to this definition"></a></dt> <dd><p>Returns the number of samples currently in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.var_opt_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.var_opt_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch and optionally prints the items</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.var_opt_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.var_opt_sketch.update" title="Link to this definition"></a></dt> <dd><p>Updates the sketch with the given value and weight</p> </dd></dl> @@ -210,7 +210,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="datasketches.var_opt_union"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">var_opt_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.var_opt_union" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">var_opt_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.var_opt_union" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_union.deserialize"> @@ -224,39 +224,39 @@ <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.var_opt_union.__init__" title="Link to this definition"></a></dt> <dd></dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_union.get_result"> -<span class="sig-name descname"><span class="pre">get_result</span></span><a class="headerlink" href="#datasketches.var_opt_union.get_result" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.var_opt_sketch" title="_datasketches.var_opt_sketch"><span class="pre">_datasketches.var_opt_sketch</span></a></span></span><a class="headerlink" href="#datasketches.var_opt_union.get_result" title="Link to this definition"></a></dt> <dd><p>Returns a sketch corresponding to the union result</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_union.get_serialized_size_bytes"> -<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><a class="headerlink" href="#datasketches.var_opt_union.get_serialized_size_bytes" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_serialized_size_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.var_opt_union.get_serialized_size_bytes" title="Link to this definition"></a></dt> <dd><p>Computes the size in bytes needed to serialize the current union</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_union.reset"> -<span class="sig-name descname"><span class="pre">reset</span></span><a class="headerlink" href="#datasketches.var_opt_union.reset" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.var_opt_union.reset" title="Link to this definition"></a></dt> <dd><p>Resets the union to the empty state</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_union.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.var_opt_union.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../helper/serde.html#datasketches.PyObjectSerDe" title="_datasketches.PyObjectSerDe"><span class="pre">_datasketches.PyObjectSerDe</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.var_opt_union.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the union into a bytes object with the provided serde</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_union.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.var_opt_union.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.var_opt_union.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.var_opt_union.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.var_opt_union.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.var_opt_sketch" title="_datasketches.var_opt_sketch"><span class="pre">_datasketches.var_opt_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.var_opt_union.update" title="Link to this definition"></a></dt> <dd><p>Updates the union with the given sketch</p> </dd></dl>
diff --git a/docs/main/search.html b/docs/main/search.html index d26add3..8a543ab 100644 --- a/docs/main/search.html +++ b/docs/main/search.html
@@ -7,15 +7,15 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Search — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" /> <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=2709fde1"></script> - <script src="_static/doctools.js?v=9bcbadda"></script> - <script src="_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="_static/doctools.js?v=fd6eb6e6"></script> + <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="_static/js/theme.js"></script> <script src="_static/searchtools.js"></script> <script src="_static/language_data.js"></script>
diff --git a/docs/main/searchindex.js b/docs/main/searchindex.js index e004661..8549fb9 100644 --- a/docs/main/searchindex.js +++ b/docs/main/searchindex.js
@@ -1 +1 @@ -Search.setIndex({"alltitles":{"Apache DataSketches":[[14,null]],"Compressed Probabilistic Counting (CPC)":[[0,null]],"CountMin Sketch":[[5,null]],"Counting Distincts":[[14,"counting-distincts"]],"Density Sketch":[[23,null]],"Distinct Counting":[[2,null]],"Exact and Bounded, Probabilitiy Proportional to Size (EBPPS) Sampling":[[20,null]],"Frequency Sketches":[[7,null],[14,"frequency-sketches"]],"Frequent Items":[[6,null]],"Helper Classes":[[8,null],[14,"helper-classes"]],"HyperLogLog (HLL)":[[1,null]],"Indices and tables":[[14,"indices-and-tables"]],"Jaccard Similarity":[[9,null]],"KLL Sketch":[[16,null]],"Kernel Function":[[10,null]],"Kolmogorov-Smirnov Test":[[11,null]],"Quantile Estimation":[[14,"quantile-estimation"]],"Quantiles Sketch (Deprecated)":[[17,null]],"Quantiles Sketches":[[15,null]],"Random Sampling":[[14,"random-sampling"]],"Random Sampling Sketches":[[21,null]],"Relative Error Quantiles (REQ) Sketch":[[18,null]],"Serialize/Deserialize (SerDe)":[[12,null]],"Theta Sketch":[[3,null]],"Tuple Policy":[[13,null]],"Tuple Sketch":[[4,null]],"Variance Optimal Sampling (VarOpt)":[[22,null]],"Vector Sketches":[[14,"vector-sketches"],[24,null]],"t-digest":[[19,null]]},"docnames":["distinct_counting/cpc","distinct_counting/hyper_log_log","distinct_counting/index","distinct_counting/theta","distinct_counting/tuple","frequency/count_min_sketch","frequency/frequent_items","frequency/index","helper/index","helper/jaccard","helper/kernel","helper/ks_test","helper/serde","helper/tuple_policy","index","quantiles/index","quantiles/kll","quantiles/quantiles_depr","quantiles/req","quantiles/tdigest","sampling/ebpps","sampling/index","sampling/varopt","vector/density_sketch","vector/index"],"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},"filenames":["distinct_counting/cpc.rst","distinct_counting/hyper_log_log.rst","distinct_counting/index.rst","distinct_counting/theta.rst","distinct_counting/tuple.rst","frequency/count_min_sketch.rst","frequency/frequent_items.rst","frequency/index.rst","helper/index.rst","helper/jaccard.rst","helper/kernel.rst","helper/ks_test.rst","helper/serde.rst","helper/tuple_policy.rst","index.rst","quantiles/index.rst","quantiles/kll.rst","quantiles/quantiles_depr.rst","quantiles/req.rst","quantiles/tdigest.rst","sampling/ebpps.rst","sampling/index.rst","sampling/varopt.rst","vector/density_sketch.rst","vector/index.rst"],"indexentries":{"__call__() (kernelfunction method)":[[10,"datasketches.KernelFunction.__call__",false]],"__call__() (tuplepolicy method)":[[13,"datasketches.TuplePolicy.__call__",false]],"__init__() (compact_theta_sketch method)":[[3,"datasketches.compact_theta_sketch.__init__",false]],"__init__() (compact_tuple_sketch method)":[[4,"datasketches.compact_tuple_sketch.__init__",false]],"__init__() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.__init__",false]],"__init__() (cpc_union method)":[[0,"datasketches.cpc_union.__init__",false]],"__init__() (density_sketch method)":[[23,"datasketches.density_sketch.__init__",false]],"__init__() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.__init__",false]],"__init__() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.__init__",false]],"__init__() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.__init__",false]],"__init__() (hll_sketch method)":[[1,"datasketches.hll_sketch.__init__",false]],"__init__() (hll_union method)":[[1,"datasketches.hll_union.__init__",false]],"__init__() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.__init__",false]],"__init__() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.__init__",false]],"__init__() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.__init__",false]],"__init__() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.__init__",false]],"__init__() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.__init__",false]],"__init__() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.__init__",false]],"__init__() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.__init__",false]],"__init__() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.__init__",false]],"__init__() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.__init__",false]],"__init__() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.__init__",false]],"__init__() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.__init__",false]],"__init__() (tdigest_double method)":[[19,"datasketches.tdigest_double.__init__",false]],"__init__() (tdigest_float method)":[[19,"datasketches.tdigest_float.__init__",false]],"__init__() (theta_a_not_b method)":[[3,"datasketches.theta_a_not_b.__init__",false]],"__init__() (theta_intersection method)":[[3,"datasketches.theta_intersection.__init__",false]],"__init__() (theta_union method)":[[3,"datasketches.theta_union.__init__",false]],"__init__() (tuple_a_not_b method)":[[4,"datasketches.tuple_a_not_b.__init__",false]],"__init__() (tuple_intersection method)":[[4,"datasketches.tuple_intersection.__init__",false]],"__init__() (tuple_union method)":[[4,"datasketches.tuple_union.__init__",false]],"__init__() (update_theta_sketch method)":[[3,"datasketches.update_theta_sketch.__init__",false]],"__init__() (update_tuple_sketch method)":[[4,"datasketches.update_tuple_sketch.__init__",false]],"__init__() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.__init__",false]],"__init__() (var_opt_union method)":[[22,"datasketches.var_opt_union.__init__",false]],"accumulatorpolicy (class in datasketches)":[[13,"datasketches.AccumulatorPolicy",false]],"c (ebpps_sketch property)":[[20,"datasketches.ebpps_sketch.c",false]],"compact (update_theta_sketch attribute)":[[3,"datasketches.update_theta_sketch.compact",false]],"compact (update_tuple_sketch attribute)":[[4,"datasketches.update_tuple_sketch.compact",false]],"compact_theta_sketch (class in datasketches)":[[3,"datasketches.compact_theta_sketch",false]],"compact_tuple_sketch (class in datasketches)":[[4,"datasketches.compact_tuple_sketch",false]],"compress (tdigest_double attribute)":[[19,"datasketches.tdigest_double.compress",false]],"compress (tdigest_float attribute)":[[19,"datasketches.tdigest_float.compress",false]],"compute (theta_a_not_b attribute)":[[3,"datasketches.theta_a_not_b.compute",false]],"compute (tuple_a_not_b attribute)":[[4,"datasketches.tuple_a_not_b.compute",false]],"count_min_sketch (class in _datasketches)":[[5,"datasketches.count_min_sketch",false]],"cpc_sketch (class in _datasketches)":[[0,"datasketches.cpc_sketch",false]],"cpc_union (class in _datasketches)":[[0,"datasketches.cpc_union",false]],"create_summary() (tuplepolicy method)":[[13,"datasketches.TuplePolicy.create_summary",false]],"default_seed (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.DEFAULT_SEED",false]],"density_sketch (class in datasketches)":[[23,"datasketches.density_sketch",false]],"deserialize() (compact_theta_sketch method)":[[3,"datasketches.compact_theta_sketch.deserialize",false]],"deserialize() (compact_tuple_sketch method)":[[4,"datasketches.compact_tuple_sketch.deserialize",false]],"deserialize() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.deserialize",false]],"deserialize() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.deserialize",false]],"deserialize() (density_sketch method)":[[23,"datasketches.density_sketch.deserialize",false]],"deserialize() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.deserialize",false]],"deserialize() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.deserialize",false]],"deserialize() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.deserialize",false]],"deserialize() (hll_sketch method)":[[1,"datasketches.hll_sketch.deserialize",false]],"deserialize() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.deserialize",false]],"deserialize() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.deserialize",false]],"deserialize() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.deserialize",false]],"deserialize() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.deserialize",false]],"deserialize() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.deserialize",false]],"deserialize() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.deserialize",false]],"deserialize() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.deserialize",false]],"deserialize() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.deserialize",false]],"deserialize() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.deserialize",false]],"deserialize() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.deserialize",false]],"deserialize() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.deserialize",false]],"deserialize() (tdigest_double method)":[[19,"datasketches.tdigest_double.deserialize",false]],"deserialize() (tdigest_float method)":[[19,"datasketches.tdigest_float.deserialize",false]],"deserialize() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.deserialize",false]],"deserialize() (var_opt_union method)":[[22,"datasketches.var_opt_union.deserialize",false]],"dim (density_sketch property)":[[23,"datasketches.density_sketch.dim",false]],"dissimilarity_test() (theta_jaccard_similarity method)":[[9,"datasketches.theta_jaccard_similarity.dissimilarity_test",false]],"dissimilarity_test() (tuple_jaccard_similarity method)":[[9,"datasketches.tuple_jaccard_similarity.dissimilarity_test",false]],"ebpps_sketch (class in datasketches)":[[20,"datasketches.ebpps_sketch",false]],"epsilon (frequent_items_sketch property)":[[6,"datasketches.frequent_items_sketch.epsilon",false]],"epsilon (frequent_strings_sketch property)":[[6,"datasketches.frequent_strings_sketch.epsilon",false]],"estimate_subset_sum (var_opt_sketch attribute)":[[22,"datasketches.var_opt_sketch.estimate_subset_sum",false]],"exactly_equal() (theta_jaccard_similarity method)":[[9,"datasketches.theta_jaccard_similarity.exactly_equal",false]],"exactly_equal() (tuple_jaccard_similarity method)":[[9,"datasketches.tuple_jaccard_similarity.exactly_equal",false]],"filter (compact_tuple_sketch attribute)":[[4,"datasketches.compact_tuple_sketch.filter",false]],"filter (update_tuple_sketch attribute)":[[4,"datasketches.update_tuple_sketch.filter",false]],"frequent_items_error_type (class in datasketches)":[[6,"datasketches.frequent_items_error_type",false]],"frequent_items_sketch (class in datasketches)":[[6,"datasketches.frequent_items_sketch",false]],"frequent_strings_sketch (class in datasketches)":[[6,"datasketches.frequent_strings_sketch",false]],"from_bytes() (pyobjectserde method)":[[12,"datasketches.PyObjectSerDe.from_bytes",false]],"gaussiankernel (class in datasketches)":[[10,"datasketches.GaussianKernel",false]],"get_apriori_error() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.get_apriori_error",false]],"get_apriori_error() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.get_apriori_error",false]],"get_cdf (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.get_cdf",false]],"get_cdf (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.get_cdf",false]],"get_cdf (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.get_cdf",false]],"get_cdf (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.get_cdf",false]],"get_cdf (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.get_cdf",false]],"get_cdf (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.get_cdf",false]],"get_cdf (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.get_cdf",false]],"get_cdf (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.get_cdf",false]],"get_cdf (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.get_cdf",false]],"get_cdf (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.get_cdf",false]],"get_cdf (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.get_cdf",false]],"get_cdf (tdigest_double attribute)":[[19,"datasketches.tdigest_double.get_cdf",false]],"get_cdf (tdigest_float attribute)":[[19,"datasketches.tdigest_float.get_cdf",false]],"get_compact_serialization_bytes (hll_sketch attribute)":[[1,"datasketches.hll_sketch.get_compact_serialization_bytes",false]],"get_epsilon_for_lg_size() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.get_epsilon_for_lg_size",false]],"get_epsilon_for_lg_size() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.get_epsilon_for_lg_size",false]],"get_estimate (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.get_estimate",false]],"get_estimate (cpc_sketch attribute)":[[0,"datasketches.cpc_sketch.get_estimate",false]],"get_estimate (density_sketch attribute)":[[23,"datasketches.density_sketch.get_estimate",false]],"get_estimate (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.get_estimate",false]],"get_estimate (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.get_estimate",false]],"get_estimate (hll_sketch attribute)":[[1,"datasketches.hll_sketch.get_estimate",false]],"get_estimate (hll_union attribute)":[[1,"datasketches.hll_union.get_estimate",false]],"get_estimate (theta_sketch attribute)":[[3,"datasketches.theta_sketch.get_estimate",false]],"get_estimate (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.get_estimate",false]],"get_frequent_items (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.get_frequent_items",false]],"get_frequent_items (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.get_frequent_items",false]],"get_lower_bound (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.get_lower_bound",false]],"get_lower_bound (cpc_sketch attribute)":[[0,"datasketches.cpc_sketch.get_lower_bound",false]],"get_lower_bound (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.get_lower_bound",false]],"get_lower_bound (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.get_lower_bound",false]],"get_lower_bound (hll_sketch attribute)":[[1,"datasketches.hll_sketch.get_lower_bound",false]],"get_lower_bound (hll_union attribute)":[[1,"datasketches.hll_union.get_lower_bound",false]],"get_lower_bound (theta_sketch attribute)":[[3,"datasketches.theta_sketch.get_lower_bound",false]],"get_lower_bound (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.get_lower_bound",false]],"get_max_updatable_serialization_bytes() (hll_sketch method)":[[1,"datasketches.hll_sketch.get_max_updatable_serialization_bytes",false]],"get_max_value (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.get_max_value",false]],"get_max_value (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.get_max_value",false]],"get_max_value (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.get_max_value",false]],"get_max_value (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.get_max_value",false]],"get_max_value (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.get_max_value",false]],"get_max_value (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.get_max_value",false]],"get_max_value (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.get_max_value",false]],"get_max_value (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.get_max_value",false]],"get_max_value (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.get_max_value",false]],"get_max_value (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.get_max_value",false]],"get_max_value (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.get_max_value",false]],"get_max_value (tdigest_double attribute)":[[19,"datasketches.tdigest_double.get_max_value",false]],"get_max_value (tdigest_float attribute)":[[19,"datasketches.tdigest_float.get_max_value",false]],"get_min_value (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.get_min_value",false]],"get_min_value (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.get_min_value",false]],"get_min_value (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.get_min_value",false]],"get_min_value (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.get_min_value",false]],"get_min_value (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.get_min_value",false]],"get_min_value (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.get_min_value",false]],"get_min_value (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.get_min_value",false]],"get_min_value (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.get_min_value",false]],"get_min_value (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.get_min_value",false]],"get_min_value (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.get_min_value",false]],"get_min_value (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.get_min_value",false]],"get_min_value (tdigest_double attribute)":[[19,"datasketches.tdigest_double.get_min_value",false]],"get_min_value (tdigest_float attribute)":[[19,"datasketches.tdigest_float.get_min_value",false]],"get_normalized_rank_error() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.get_normalized_rank_error",false]],"get_pmf (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.get_pmf",false]],"get_pmf (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.get_pmf",false]],"get_pmf (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.get_pmf",false]],"get_pmf (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.get_pmf",false]],"get_pmf (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.get_pmf",false]],"get_pmf (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.get_pmf",false]],"get_pmf (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.get_pmf",false]],"get_pmf (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.get_pmf",false]],"get_pmf (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.get_pmf",false]],"get_pmf (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.get_pmf",false]],"get_pmf (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.get_pmf",false]],"get_pmf (tdigest_double attribute)":[[19,"datasketches.tdigest_double.get_pmf",false]],"get_pmf (tdigest_float attribute)":[[19,"datasketches.tdigest_float.get_pmf",false]],"get_quantile (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.get_quantile",false]],"get_quantile (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.get_quantile",false]],"get_quantile (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.get_quantile",false]],"get_quantile (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.get_quantile",false]],"get_quantile (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.get_quantile",false]],"get_quantile (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.get_quantile",false]],"get_quantile (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.get_quantile",false]],"get_quantile (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.get_quantile",false]],"get_quantile (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.get_quantile",false]],"get_quantile (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.get_quantile",false]],"get_quantile (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.get_quantile",false]],"get_quantile (tdigest_double attribute)":[[19,"datasketches.tdigest_double.get_quantile",false]],"get_quantile (tdigest_float attribute)":[[19,"datasketches.tdigest_float.get_quantile",false]],"get_quantiles (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.get_quantiles",false]],"get_quantiles (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.get_quantiles",false]],"get_quantiles (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.get_quantiles",false]],"get_quantiles (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.get_quantiles",false]],"get_quantiles (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.get_quantiles",false]],"get_quantiles (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.get_quantiles",false]],"get_quantiles (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.get_quantiles",false]],"get_quantiles (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.get_quantiles",false]],"get_quantiles (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.get_quantiles",false]],"get_quantiles (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.get_quantiles",false]],"get_quantiles (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.get_quantiles",false]],"get_rank (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.get_rank",false]],"get_rank (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.get_rank",false]],"get_rank (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.get_rank",false]],"get_rank (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.get_rank",false]],"get_rank (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.get_rank",false]],"get_rank (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.get_rank",false]],"get_rank (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.get_rank",false]],"get_rank (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.get_rank",false]],"get_rank (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.get_rank",false]],"get_rank (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.get_rank",false]],"get_rank (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.get_rank",false]],"get_rank (tdigest_double attribute)":[[19,"datasketches.tdigest_double.get_rank",false]],"get_rank (tdigest_float attribute)":[[19,"datasketches.tdigest_float.get_rank",false]],"get_rank_lower_bound (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.get_rank_lower_bound",false]],"get_rank_lower_bound (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.get_rank_lower_bound",false]],"get_rank_lower_bound (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.get_rank_lower_bound",false]],"get_rank_upper_bound (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.get_rank_upper_bound",false]],"get_rank_upper_bound (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.get_rank_upper_bound",false]],"get_rank_upper_bound (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.get_rank_upper_bound",false]],"get_rel_err() (hll_sketch method)":[[1,"datasketches.hll_sketch.get_rel_err",false]],"get_rel_err() (hll_union method)":[[1,"datasketches.hll_union.get_rel_err",false]],"get_relative_error (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.get_relative_error",false]],"get_result (cpc_union attribute)":[[0,"datasketches.cpc_union.get_result",false]],"get_result (hll_union attribute)":[[1,"datasketches.hll_union.get_result",false]],"get_result (theta_intersection attribute)":[[3,"datasketches.theta_intersection.get_result",false]],"get_result (theta_union attribute)":[[3,"datasketches.theta_union.get_result",false]],"get_result (tuple_intersection attribute)":[[4,"datasketches.tuple_intersection.get_result",false]],"get_result (tuple_union attribute)":[[4,"datasketches.tuple_union.get_result",false]],"get_result (var_opt_union attribute)":[[22,"datasketches.var_opt_union.get_result",false]],"get_rse() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_RSE",false]],"get_rse() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_RSE",false]],"get_rse() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_RSE",false]],"get_seed_hash (theta_sketch attribute)":[[3,"datasketches.theta_sketch.get_seed_hash",false]],"get_seed_hash (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.get_seed_hash",false]],"get_serialized_size_bytes (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes (ebpps_sketch attribute)":[[20,"datasketches.ebpps_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes (tdigest_double attribute)":[[19,"datasketches.tdigest_double.get_serialized_size_bytes",false]],"get_serialized_size_bytes (tdigest_float attribute)":[[19,"datasketches.tdigest_float.get_serialized_size_bytes",false]],"get_serialized_size_bytes (var_opt_sketch attribute)":[[22,"datasketches.var_opt_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes (var_opt_union attribute)":[[22,"datasketches.var_opt_union.get_serialized_size_bytes",false]],"get_size() (pyobjectserde method)":[[12,"datasketches.PyObjectSerDe.get_size",false]],"get_total_weight (tdigest_double attribute)":[[19,"datasketches.tdigest_double.get_total_weight",false]],"get_total_weight (tdigest_float attribute)":[[19,"datasketches.tdigest_float.get_total_weight",false]],"get_updatable_serialization_bytes (hll_sketch attribute)":[[1,"datasketches.hll_sketch.get_updatable_serialization_bytes",false]],"get_upper_bound (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.get_upper_bound",false]],"get_upper_bound (cpc_sketch attribute)":[[0,"datasketches.cpc_sketch.get_upper_bound",false]],"get_upper_bound (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.get_upper_bound",false]],"get_upper_bound (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.get_upper_bound",false]],"get_upper_bound (hll_sketch attribute)":[[1,"datasketches.hll_sketch.get_upper_bound",false]],"get_upper_bound (hll_union attribute)":[[1,"datasketches.hll_union.get_upper_bound",false]],"get_upper_bound (theta_sketch attribute)":[[3,"datasketches.theta_sketch.get_upper_bound",false]],"get_upper_bound (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.get_upper_bound",false]],"has_result (theta_intersection attribute)":[[3,"datasketches.theta_intersection.has_result",false]],"has_result (tuple_intersection attribute)":[[4,"datasketches.tuple_intersection.has_result",false]],"hll_4 (tgt_hll_type attribute)":[[1,"datasketches.tgt_hll_type.HLL_4",false]],"hll_6 (tgt_hll_type attribute)":[[1,"datasketches.tgt_hll_type.HLL_6",false]],"hll_8 (tgt_hll_type attribute)":[[1,"datasketches.tgt_hll_type.HLL_8",false]],"hll_sketch (class in _datasketches)":[[1,"datasketches.hll_sketch",false]],"hll_union (class in _datasketches)":[[1,"datasketches.hll_union",false]],"is_compact (hll_sketch attribute)":[[1,"datasketches.hll_sketch.is_compact",false]],"is_empty (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.is_empty",false]],"is_empty (cpc_sketch attribute)":[[0,"datasketches.cpc_sketch.is_empty",false]],"is_empty (density_sketch attribute)":[[23,"datasketches.density_sketch.is_empty",false]],"is_empty (ebpps_sketch attribute)":[[20,"datasketches.ebpps_sketch.is_empty",false]],"is_empty (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.is_empty",false]],"is_empty (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.is_empty",false]],"is_empty (hll_sketch attribute)":[[1,"datasketches.hll_sketch.is_empty",false]],"is_empty (hll_union attribute)":[[1,"datasketches.hll_union.is_empty",false]],"is_empty (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.is_empty",false]],"is_empty (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.is_empty",false]],"is_empty (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.is_empty",false]],"is_empty (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.is_empty",false]],"is_empty (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.is_empty",false]],"is_empty (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.is_empty",false]],"is_empty (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.is_empty",false]],"is_empty (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.is_empty",false]],"is_empty (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.is_empty",false]],"is_empty (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.is_empty",false]],"is_empty (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.is_empty",false]],"is_empty (tdigest_double attribute)":[[19,"datasketches.tdigest_double.is_empty",false]],"is_empty (tdigest_float attribute)":[[19,"datasketches.tdigest_float.is_empty",false]],"is_empty (theta_sketch attribute)":[[3,"datasketches.theta_sketch.is_empty",false]],"is_empty (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.is_empty",false]],"is_empty (var_opt_sketch attribute)":[[22,"datasketches.var_opt_sketch.is_empty",false]],"is_estimation_mode (density_sketch attribute)":[[23,"datasketches.density_sketch.is_estimation_mode",false]],"is_estimation_mode (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.is_estimation_mode",false]],"is_estimation_mode (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.is_estimation_mode",false]],"is_estimation_mode (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.is_estimation_mode",false]],"is_estimation_mode (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.is_estimation_mode",false]],"is_estimation_mode (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.is_estimation_mode",false]],"is_estimation_mode (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.is_estimation_mode",false]],"is_estimation_mode (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.is_estimation_mode",false]],"is_estimation_mode (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.is_estimation_mode",false]],"is_estimation_mode (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.is_estimation_mode",false]],"is_estimation_mode (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.is_estimation_mode",false]],"is_estimation_mode (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.is_estimation_mode",false]],"is_estimation_mode (theta_sketch attribute)":[[3,"datasketches.theta_sketch.is_estimation_mode",false]],"is_estimation_mode (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.is_estimation_mode",false]],"is_hra (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.is_hra",false]],"is_hra (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.is_hra",false]],"is_hra (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.is_hra",false]],"is_ordered (theta_sketch attribute)":[[3,"datasketches.theta_sketch.is_ordered",false]],"is_ordered (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.is_ordered",false]],"jaccard() (theta_jaccard_similarity method)":[[9,"datasketches.theta_jaccard_similarity.jaccard",false]],"jaccard() (tuple_jaccard_similarity method)":[[9,"datasketches.tuple_jaccard_similarity.jaccard",false]],"k (density_sketch property)":[[23,"datasketches.density_sketch.k",false]],"k (ebpps_sketch property)":[[20,"datasketches.ebpps_sketch.k",false]],"k (kll_doubles_sketch property)":[[16,"datasketches.kll_doubles_sketch.k",false]],"k (kll_floats_sketch property)":[[16,"datasketches.kll_floats_sketch.k",false]],"k (kll_ints_sketch property)":[[16,"datasketches.kll_ints_sketch.k",false]],"k (kll_items_sketch property)":[[16,"datasketches.kll_items_sketch.k",false]],"k (quantiles_doubles_sketch property)":[[17,"datasketches.quantiles_doubles_sketch.k",false]],"k (quantiles_floats_sketch property)":[[17,"datasketches.quantiles_floats_sketch.k",false]],"k (quantiles_ints_sketch property)":[[17,"datasketches.quantiles_ints_sketch.k",false]],"k (quantiles_items_sketch property)":[[17,"datasketches.quantiles_items_sketch.k",false]],"k (req_floats_sketch property)":[[18,"datasketches.req_floats_sketch.k",false]],"k (req_ints_sketch property)":[[18,"datasketches.req_ints_sketch.k",false]],"k (req_items_sketch property)":[[18,"datasketches.req_items_sketch.k",false]],"k (tdigest_double property)":[[19,"datasketches.tdigest_double.k",false]],"k (tdigest_float property)":[[19,"datasketches.tdigest_float.k",false]],"k (var_opt_sketch property)":[[22,"datasketches.var_opt_sketch.k",false]],"kernelfunction (class in datasketches)":[[10,"datasketches.KernelFunction",false]],"kll_doubles_sketch (class in datasketches)":[[16,"datasketches.kll_doubles_sketch",false]],"kll_floats_sketch (class in datasketches)":[[16,"datasketches.kll_floats_sketch",false]],"kll_ints_sketch (class in datasketches)":[[16,"datasketches.kll_ints_sketch",false]],"kll_items_sketch (class in datasketches)":[[16,"datasketches.kll_items_sketch",false]],"ks_test() (in module datasketches)":[[11,"datasketches.ks_test",false]],"lg_config_k (hll_sketch property)":[[1,"datasketches.hll_sketch.lg_config_k",false]],"lg_config_k (hll_union property)":[[1,"datasketches.hll_union.lg_config_k",false]],"lg_k (cpc_sketch property)":[[0,"datasketches.cpc_sketch.lg_k",false]],"maxintpolicy (class in datasketches)":[[13,"datasketches.MaxIntPolicy",false]],"merge (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.merge",false]],"merge (density_sketch attribute)":[[23,"datasketches.density_sketch.merge",false]],"merge (ebpps_sketch attribute)":[[20,"datasketches.ebpps_sketch.merge",false]],"merge (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.merge",false]],"merge (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.merge",false]],"merge (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.merge",false]],"merge (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.merge",false]],"merge (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.merge",false]],"merge (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.merge",false]],"merge (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.merge",false]],"merge (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.merge",false]],"merge (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.merge",false]],"merge (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.merge",false]],"merge (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.merge",false]],"merge (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.merge",false]],"merge (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.merge",false]],"merge (tdigest_double attribute)":[[19,"datasketches.tdigest_double.merge",false]],"merge (tdigest_float attribute)":[[19,"datasketches.tdigest_float.merge",false]],"minintpolicy (class in datasketches)":[[13,"datasketches.MinIntPolicy",false]],"n (density_sketch property)":[[23,"datasketches.density_sketch.n",false]],"n (ebpps_sketch property)":[[20,"datasketches.ebpps_sketch.n",false]],"n (kll_doubles_sketch property)":[[16,"datasketches.kll_doubles_sketch.n",false]],"n (kll_floats_sketch property)":[[16,"datasketches.kll_floats_sketch.n",false]],"n (kll_ints_sketch property)":[[16,"datasketches.kll_ints_sketch.n",false]],"n (kll_items_sketch property)":[[16,"datasketches.kll_items_sketch.n",false]],"n (quantiles_doubles_sketch property)":[[17,"datasketches.quantiles_doubles_sketch.n",false]],"n (quantiles_floats_sketch property)":[[17,"datasketches.quantiles_floats_sketch.n",false]],"n (quantiles_ints_sketch property)":[[17,"datasketches.quantiles_ints_sketch.n",false]],"n (quantiles_items_sketch property)":[[17,"datasketches.quantiles_items_sketch.n",false]],"n (req_floats_sketch property)":[[18,"datasketches.req_floats_sketch.n",false]],"n (req_ints_sketch property)":[[18,"datasketches.req_ints_sketch.n",false]],"n (req_items_sketch property)":[[18,"datasketches.req_items_sketch.n",false]],"n (var_opt_sketch property)":[[22,"datasketches.var_opt_sketch.n",false]],"no_false_negatives (frequent_items_error_type attribute)":[[6,"datasketches.frequent_items_error_type.NO_FALSE_NEGATIVES",false]],"no_false_positives (frequent_items_error_type attribute)":[[6,"datasketches.frequent_items_error_type.NO_FALSE_POSITIVES",false]],"normalized_rank_error (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.normalized_rank_error",false]],"normalized_rank_error (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.normalized_rank_error",false]],"normalized_rank_error (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.normalized_rank_error",false]],"normalized_rank_error (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.normalized_rank_error",false]],"normalized_rank_error (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.normalized_rank_error",false]],"normalized_rank_error (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.normalized_rank_error",false]],"normalized_rank_error (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.normalized_rank_error",false]],"normalized_rank_error (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.normalized_rank_error",false]],"num_active_items (frequent_items_sketch property)":[[6,"datasketches.frequent_items_sketch.num_active_items",false]],"num_active_items (frequent_strings_sketch property)":[[6,"datasketches.frequent_strings_sketch.num_active_items",false]],"num_buckets (count_min_sketch property)":[[5,"datasketches.count_min_sketch.num_buckets",false]],"num_hashes (count_min_sketch property)":[[5,"datasketches.count_min_sketch.num_hashes",false]],"num_retained (density_sketch property)":[[23,"datasketches.density_sketch.num_retained",false]],"num_retained (kll_doubles_sketch property)":[[16,"datasketches.kll_doubles_sketch.num_retained",false]],"num_retained (kll_floats_sketch property)":[[16,"datasketches.kll_floats_sketch.num_retained",false]],"num_retained (kll_ints_sketch property)":[[16,"datasketches.kll_ints_sketch.num_retained",false]],"num_retained (kll_items_sketch property)":[[16,"datasketches.kll_items_sketch.num_retained",false]],"num_retained (quantiles_doubles_sketch property)":[[17,"datasketches.quantiles_doubles_sketch.num_retained",false]],"num_retained (quantiles_floats_sketch property)":[[17,"datasketches.quantiles_floats_sketch.num_retained",false]],"num_retained (quantiles_ints_sketch property)":[[17,"datasketches.quantiles_ints_sketch.num_retained",false]],"num_retained (quantiles_items_sketch property)":[[17,"datasketches.quantiles_items_sketch.num_retained",false]],"num_retained (req_floats_sketch property)":[[18,"datasketches.req_floats_sketch.num_retained",false]],"num_retained (req_ints_sketch property)":[[18,"datasketches.req_ints_sketch.num_retained",false]],"num_retained (req_items_sketch property)":[[18,"datasketches.req_items_sketch.num_retained",false]],"num_retained (theta_sketch property)":[[3,"datasketches.theta_sketch.num_retained",false]],"num_retained (tuple_sketch property)":[[4,"datasketches.tuple_sketch.num_retained",false]],"num_samples (var_opt_sketch property)":[[22,"datasketches.var_opt_sketch.num_samples",false]],"pydoublesserde (class in datasketches)":[[12,"datasketches.PyDoublesSerDe",false]],"pyfloatsserde (class in datasketches)":[[12,"datasketches.PyFloatsSerDe",false]],"pyintsserde (class in datasketches)":[[12,"datasketches.PyIntsSerDe",false]],"pylongsserde (class in datasketches)":[[12,"datasketches.PyLongsSerDe",false]],"pyobjectserde (class in datasketches)":[[12,"datasketches.PyObjectSerDe",false]],"pystringsserde (class in datasketches)":[[12,"datasketches.PyStringsSerDe",false]],"quantiles_doubles_sketch (class in datasketches)":[[17,"datasketches.quantiles_doubles_sketch",false]],"quantiles_floats_sketch (class in datasketches)":[[17,"datasketches.quantiles_floats_sketch",false]],"quantiles_ints_sketch (class in datasketches)":[[17,"datasketches.quantiles_ints_sketch",false]],"quantiles_items_sketch (class in datasketches)":[[17,"datasketches.quantiles_items_sketch",false]],"req_floats_sketch (class in datasketches)":[[18,"datasketches.req_floats_sketch",false]],"req_ints_sketch (class in datasketches)":[[18,"datasketches.req_ints_sketch",false]],"req_items_sketch (class in datasketches)":[[18,"datasketches.req_items_sketch",false]],"reset (hll_sketch attribute)":[[1,"datasketches.hll_sketch.reset",false]],"reset (hll_union attribute)":[[1,"datasketches.hll_union.reset",false]],"reset (tuple_union attribute)":[[4,"datasketches.tuple_union.reset",false]],"reset (update_theta_sketch attribute)":[[3,"datasketches.update_theta_sketch.reset",false]],"reset (update_tuple_sketch attribute)":[[4,"datasketches.update_tuple_sketch.reset",false]],"reset (var_opt_union attribute)":[[22,"datasketches.var_opt_union.reset",false]],"seed (count_min_sketch property)":[[5,"datasketches.count_min_sketch.seed",false]],"serialize (compact_theta_sketch attribute)":[[3,"datasketches.compact_theta_sketch.serialize",false]],"serialize (compact_tuple_sketch attribute)":[[4,"datasketches.compact_tuple_sketch.serialize",false]],"serialize (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.serialize",false]],"serialize (cpc_sketch attribute)":[[0,"datasketches.cpc_sketch.serialize",false]],"serialize (density_sketch attribute)":[[23,"datasketches.density_sketch.serialize",false]],"serialize (ebpps_sketch attribute)":[[20,"datasketches.ebpps_sketch.serialize",false]],"serialize (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.serialize",false]],"serialize (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.serialize",false]],"serialize (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.serialize",false]],"serialize (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.serialize",false]],"serialize (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.serialize",false]],"serialize (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.serialize",false]],"serialize (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.serialize",false]],"serialize (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.serialize",false]],"serialize (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.serialize",false]],"serialize (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.serialize",false]],"serialize (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.serialize",false]],"serialize (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.serialize",false]],"serialize (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.serialize",false]],"serialize (tdigest_double attribute)":[[19,"datasketches.tdigest_double.serialize",false]],"serialize (tdigest_float attribute)":[[19,"datasketches.tdigest_float.serialize",false]],"serialize (var_opt_sketch attribute)":[[22,"datasketches.var_opt_sketch.serialize",false]],"serialize (var_opt_union attribute)":[[22,"datasketches.var_opt_union.serialize",false]],"serialize_compact (hll_sketch attribute)":[[1,"datasketches.hll_sketch.serialize_compact",false]],"serialize_updatable (hll_sketch attribute)":[[1,"datasketches.hll_sketch.serialize_updatable",false]],"similarity_test() (theta_jaccard_similarity method)":[[9,"datasketches.theta_jaccard_similarity.similarity_test",false]],"similarity_test() (tuple_jaccard_similarity method)":[[9,"datasketches.tuple_jaccard_similarity.similarity_test",false]],"suggest_num_buckets() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.suggest_num_buckets",false]],"suggest_num_hashes() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.suggest_num_hashes",false]],"tdigest_double (class in datasketches)":[[19,"datasketches.tdigest_double",false]],"tdigest_float (class in datasketches)":[[19,"datasketches.tdigest_float",false]],"tgt_hll_type (class in _datasketches)":[[1,"datasketches.tgt_hll_type",false]],"tgt_type (hll_sketch property)":[[1,"datasketches.hll_sketch.tgt_type",false]],"theta (theta_sketch property)":[[3,"datasketches.theta_sketch.theta",false]],"theta (tuple_sketch property)":[[4,"datasketches.tuple_sketch.theta",false]],"theta64 (theta_sketch property)":[[3,"datasketches.theta_sketch.theta64",false]],"theta64 (tuple_sketch property)":[[4,"datasketches.tuple_sketch.theta64",false]],"theta_a_not_b (class in datasketches)":[[3,"datasketches.theta_a_not_b",false]],"theta_intersection (class in datasketches)":[[3,"datasketches.theta_intersection",false]],"theta_jaccard_similarity (class in datasketches)":[[9,"datasketches.theta_jaccard_similarity",false]],"theta_sketch (class in datasketches)":[[3,"datasketches.theta_sketch",false]],"theta_union (class in datasketches)":[[3,"datasketches.theta_union",false]],"to_bytes() (pyobjectserde method)":[[12,"datasketches.PyObjectSerDe.to_bytes",false]],"to_string (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.to_string",false]],"to_string (cpc_sketch attribute)":[[0,"datasketches.cpc_sketch.to_string",false]],"to_string (density_sketch attribute)":[[23,"datasketches.density_sketch.to_string",false]],"to_string (ebpps_sketch attribute)":[[20,"datasketches.ebpps_sketch.to_string",false]],"to_string (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.to_string",false]],"to_string (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.to_string",false]],"to_string (hll_sketch attribute)":[[1,"datasketches.hll_sketch.to_string",false]],"to_string (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.to_string",false]],"to_string (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.to_string",false]],"to_string (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.to_string",false]],"to_string (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.to_string",false]],"to_string (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.to_string",false]],"to_string (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.to_string",false]],"to_string (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.to_string",false]],"to_string (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.to_string",false]],"to_string (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.to_string",false]],"to_string (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.to_string",false]],"to_string (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.to_string",false]],"to_string (tdigest_double attribute)":[[19,"datasketches.tdigest_double.to_string",false]],"to_string (tdigest_float attribute)":[[19,"datasketches.tdigest_float.to_string",false]],"to_string (theta_sketch attribute)":[[3,"datasketches.theta_sketch.to_string",false]],"to_string (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.to_string",false]],"to_string (var_opt_sketch attribute)":[[22,"datasketches.var_opt_sketch.to_string",false]],"to_string (var_opt_union attribute)":[[22,"datasketches.var_opt_union.to_string",false]],"total_weight (count_min_sketch property)":[[5,"datasketches.count_min_sketch.total_weight",false]],"total_weight (frequent_items_sketch property)":[[6,"datasketches.frequent_items_sketch.total_weight",false]],"total_weight (frequent_strings_sketch property)":[[6,"datasketches.frequent_strings_sketch.total_weight",false]],"trim (update_theta_sketch attribute)":[[3,"datasketches.update_theta_sketch.trim",false]],"trim (update_tuple_sketch attribute)":[[4,"datasketches.update_tuple_sketch.trim",false]],"tuple_a_not_b (class in datasketches)":[[4,"datasketches.tuple_a_not_b",false]],"tuple_intersection (class in datasketches)":[[4,"datasketches.tuple_intersection",false]],"tuple_jaccard_similarity (class in datasketches)":[[9,"datasketches.tuple_jaccard_similarity",false]],"tuple_sketch (class in datasketches)":[[4,"datasketches.tuple_sketch",false]],"tuple_union (class in datasketches)":[[4,"datasketches.tuple_union",false]],"tuplepolicy (class in datasketches)":[[13,"datasketches.TuplePolicy",false]],"update (count_min_sketch attribute)":[[5,"datasketches.count_min_sketch.update",false]],"update (cpc_sketch attribute)":[[0,"datasketches.cpc_sketch.update",false]],"update (cpc_union attribute)":[[0,"datasketches.cpc_union.update",false]],"update (density_sketch attribute)":[[23,"datasketches.density_sketch.update",false]],"update (ebpps_sketch attribute)":[[20,"datasketches.ebpps_sketch.update",false]],"update (frequent_items_sketch attribute)":[[6,"datasketches.frequent_items_sketch.update",false]],"update (frequent_strings_sketch attribute)":[[6,"datasketches.frequent_strings_sketch.update",false]],"update (hll_sketch attribute)":[[1,"datasketches.hll_sketch.update",false]],"update (hll_union attribute)":[[1,"datasketches.hll_union.update",false]],"update (kll_doubles_sketch attribute)":[[16,"datasketches.kll_doubles_sketch.update",false]],"update (kll_floats_sketch attribute)":[[16,"datasketches.kll_floats_sketch.update",false]],"update (kll_ints_sketch attribute)":[[16,"datasketches.kll_ints_sketch.update",false]],"update (kll_items_sketch attribute)":[[16,"datasketches.kll_items_sketch.update",false]],"update (quantiles_doubles_sketch attribute)":[[17,"datasketches.quantiles_doubles_sketch.update",false]],"update (quantiles_floats_sketch attribute)":[[17,"datasketches.quantiles_floats_sketch.update",false]],"update (quantiles_ints_sketch attribute)":[[17,"datasketches.quantiles_ints_sketch.update",false]],"update (quantiles_items_sketch attribute)":[[17,"datasketches.quantiles_items_sketch.update",false]],"update (req_floats_sketch attribute)":[[18,"datasketches.req_floats_sketch.update",false]],"update (req_ints_sketch attribute)":[[18,"datasketches.req_ints_sketch.update",false]],"update (req_items_sketch attribute)":[[18,"datasketches.req_items_sketch.update",false]],"update (tdigest_double attribute)":[[19,"datasketches.tdigest_double.update",false]],"update (tdigest_float attribute)":[[19,"datasketches.tdigest_float.update",false]],"update (theta_intersection attribute)":[[3,"datasketches.theta_intersection.update",false]],"update (theta_union attribute)":[[3,"datasketches.theta_union.update",false]],"update (tuple_intersection attribute)":[[4,"datasketches.tuple_intersection.update",false]],"update (tuple_union attribute)":[[4,"datasketches.tuple_union.update",false]],"update (update_theta_sketch attribute)":[[3,"datasketches.update_theta_sketch.update",false]],"update (update_tuple_sketch attribute)":[[4,"datasketches.update_tuple_sketch.update",false]],"update (var_opt_sketch attribute)":[[22,"datasketches.var_opt_sketch.update",false]],"update (var_opt_union attribute)":[[22,"datasketches.var_opt_union.update",false]],"update_summary() (tuplepolicy method)":[[13,"datasketches.TuplePolicy.update_summary",false]],"update_theta_sketch (class in datasketches)":[[3,"datasketches.update_theta_sketch",false]],"update_tuple_sketch (class in datasketches)":[[4,"datasketches.update_tuple_sketch",false]],"var_opt_sketch (class in datasketches)":[[22,"datasketches.var_opt_sketch",false]],"var_opt_union (class in datasketches)":[[22,"datasketches.var_opt_union",false]]},"objects":{"_datasketches":[[5,0,1,"datasketches.count_min_sketch","count_min_sketch"],[0,0,1,"datasketches.cpc_sketch","cpc_sketch"],[0,0,1,"datasketches.cpc_union","cpc_union"],[1,0,1,"datasketches.hll_sketch","hll_sketch"],[1,0,1,"datasketches.hll_union","hll_union"],[1,0,1,"datasketches.tgt_hll_type","tgt_hll_type"]],"_datasketches.count_min_sketch":[[5,1,1,"datasketches.count_min_sketch.deserialize","deserialize"],[5,2,1,"datasketches.count_min_sketch.get_estimate","get_estimate"],[5,2,1,"datasketches.count_min_sketch.get_lower_bound","get_lower_bound"],[5,2,1,"datasketches.count_min_sketch.get_relative_error","get_relative_error"],[5,2,1,"datasketches.count_min_sketch.get_serialized_size_bytes","get_serialized_size_bytes"],[5,2,1,"datasketches.count_min_sketch.get_upper_bound","get_upper_bound"],[5,2,1,"datasketches.count_min_sketch.is_empty","is_empty"],[5,2,1,"datasketches.count_min_sketch.merge","merge"],[5,3,1,"datasketches.count_min_sketch.num_buckets","num_buckets"],[5,3,1,"datasketches.count_min_sketch.num_hashes","num_hashes"],[5,3,1,"datasketches.count_min_sketch.seed","seed"],[5,2,1,"datasketches.count_min_sketch.serialize","serialize"],[5,1,1,"datasketches.count_min_sketch.suggest_num_buckets","suggest_num_buckets"],[5,1,1,"datasketches.count_min_sketch.suggest_num_hashes","suggest_num_hashes"],[5,2,1,"datasketches.count_min_sketch.to_string","to_string"],[5,3,1,"datasketches.count_min_sketch.total_weight","total_weight"],[5,2,1,"datasketches.count_min_sketch.update","update"]],"_datasketches.cpc_sketch":[[0,1,1,"datasketches.cpc_sketch.__init__","__init__"],[0,1,1,"datasketches.cpc_sketch.deserialize","deserialize"],[0,2,1,"datasketches.cpc_sketch.get_estimate","get_estimate"],[0,2,1,"datasketches.cpc_sketch.get_lower_bound","get_lower_bound"],[0,2,1,"datasketches.cpc_sketch.get_upper_bound","get_upper_bound"],[0,2,1,"datasketches.cpc_sketch.is_empty","is_empty"],[0,3,1,"datasketches.cpc_sketch.lg_k","lg_k"],[0,2,1,"datasketches.cpc_sketch.serialize","serialize"],[0,2,1,"datasketches.cpc_sketch.to_string","to_string"],[0,2,1,"datasketches.cpc_sketch.update","update"]],"_datasketches.cpc_union":[[0,1,1,"datasketches.cpc_union.__init__","__init__"],[0,2,1,"datasketches.cpc_union.get_result","get_result"],[0,2,1,"datasketches.cpc_union.update","update"]],"_datasketches.hll_sketch":[[1,1,1,"datasketches.hll_sketch.__init__","__init__"],[1,1,1,"datasketches.hll_sketch.deserialize","deserialize"],[1,2,1,"datasketches.hll_sketch.get_compact_serialization_bytes","get_compact_serialization_bytes"],[1,2,1,"datasketches.hll_sketch.get_estimate","get_estimate"],[1,2,1,"datasketches.hll_sketch.get_lower_bound","get_lower_bound"],[1,1,1,"datasketches.hll_sketch.get_max_updatable_serialization_bytes","get_max_updatable_serialization_bytes"],[1,1,1,"datasketches.hll_sketch.get_rel_err","get_rel_err"],[1,2,1,"datasketches.hll_sketch.get_updatable_serialization_bytes","get_updatable_serialization_bytes"],[1,2,1,"datasketches.hll_sketch.get_upper_bound","get_upper_bound"],[1,2,1,"datasketches.hll_sketch.is_compact","is_compact"],[1,2,1,"datasketches.hll_sketch.is_empty","is_empty"],[1,3,1,"datasketches.hll_sketch.lg_config_k","lg_config_k"],[1,2,1,"datasketches.hll_sketch.reset","reset"],[1,2,1,"datasketches.hll_sketch.serialize_compact","serialize_compact"],[1,2,1,"datasketches.hll_sketch.serialize_updatable","serialize_updatable"],[1,3,1,"datasketches.hll_sketch.tgt_type","tgt_type"],[1,2,1,"datasketches.hll_sketch.to_string","to_string"],[1,2,1,"datasketches.hll_sketch.update","update"]],"_datasketches.hll_union":[[1,1,1,"datasketches.hll_union.__init__","__init__"],[1,2,1,"datasketches.hll_union.get_estimate","get_estimate"],[1,2,1,"datasketches.hll_union.get_lower_bound","get_lower_bound"],[1,1,1,"datasketches.hll_union.get_rel_err","get_rel_err"],[1,2,1,"datasketches.hll_union.get_result","get_result"],[1,2,1,"datasketches.hll_union.get_upper_bound","get_upper_bound"],[1,2,1,"datasketches.hll_union.is_empty","is_empty"],[1,3,1,"datasketches.hll_union.lg_config_k","lg_config_k"],[1,2,1,"datasketches.hll_union.reset","reset"],[1,2,1,"datasketches.hll_union.update","update"]],"_datasketches.tgt_hll_type":[[1,2,1,"datasketches.tgt_hll_type.HLL_4","HLL_4"],[1,2,1,"datasketches.tgt_hll_type.HLL_6","HLL_6"],[1,2,1,"datasketches.tgt_hll_type.HLL_8","HLL_8"]],"datasketches":[[13,0,1,"","AccumulatorPolicy"],[10,0,1,"","GaussianKernel"],[10,0,1,"","KernelFunction"],[13,0,1,"","MaxIntPolicy"],[13,0,1,"","MinIntPolicy"],[12,0,1,"","PyDoublesSerDe"],[12,0,1,"","PyFloatsSerDe"],[12,0,1,"","PyIntsSerDe"],[12,0,1,"","PyLongsSerDe"],[12,0,1,"","PyObjectSerDe"],[12,0,1,"","PyStringsSerDe"],[13,0,1,"","TuplePolicy"],[3,0,1,"","compact_theta_sketch"],[4,0,1,"","compact_tuple_sketch"],[23,0,1,"","density_sketch"],[20,0,1,"","ebpps_sketch"],[6,0,1,"","frequent_items_error_type"],[6,0,1,"","frequent_items_sketch"],[6,0,1,"","frequent_strings_sketch"],[16,0,1,"","kll_doubles_sketch"],[16,0,1,"","kll_floats_sketch"],[16,0,1,"","kll_ints_sketch"],[16,0,1,"","kll_items_sketch"],[11,4,1,"","ks_test"],[17,0,1,"","quantiles_doubles_sketch"],[17,0,1,"","quantiles_floats_sketch"],[17,0,1,"","quantiles_ints_sketch"],[17,0,1,"","quantiles_items_sketch"],[18,0,1,"","req_floats_sketch"],[18,0,1,"","req_ints_sketch"],[18,0,1,"","req_items_sketch"],[19,0,1,"","tdigest_double"],[19,0,1,"","tdigest_float"],[3,0,1,"","theta_a_not_b"],[3,0,1,"","theta_intersection"],[9,0,1,"","theta_jaccard_similarity"],[3,0,1,"","theta_sketch"],[3,0,1,"","theta_union"],[4,0,1,"","tuple_a_not_b"],[4,0,1,"","tuple_intersection"],[9,0,1,"","tuple_jaccard_similarity"],[4,0,1,"","tuple_sketch"],[4,0,1,"","tuple_union"],[3,0,1,"","update_theta_sketch"],[4,0,1,"","update_tuple_sketch"],[22,0,1,"","var_opt_sketch"],[22,0,1,"","var_opt_union"]],"datasketches.KernelFunction":[[10,1,1,"","__call__"]],"datasketches.PyObjectSerDe":[[12,1,1,"","from_bytes"],[12,1,1,"","get_size"],[12,1,1,"","to_bytes"]],"datasketches.TuplePolicy":[[13,1,1,"","__call__"],[13,1,1,"","create_summary"],[13,1,1,"","update_summary"]],"datasketches.compact_theta_sketch":[[3,1,1,"","__init__"],[3,1,1,"","deserialize"],[3,2,1,"","serialize"]],"datasketches.compact_tuple_sketch":[[4,1,1,"","__init__"],[4,1,1,"","deserialize"],[4,2,1,"","filter"],[4,2,1,"","serialize"]],"datasketches.density_sketch":[[23,1,1,"","__init__"],[23,1,1,"","deserialize"],[23,3,1,"","dim"],[23,2,1,"","get_estimate"],[23,2,1,"","is_empty"],[23,2,1,"","is_estimation_mode"],[23,3,1,"","k"],[23,2,1,"","merge"],[23,3,1,"","n"],[23,3,1,"","num_retained"],[23,2,1,"","serialize"],[23,2,1,"","to_string"],[23,2,1,"","update"]],"datasketches.ebpps_sketch":[[20,1,1,"","__init__"],[20,3,1,"","c"],[20,1,1,"","deserialize"],[20,2,1,"","get_serialized_size_bytes"],[20,2,1,"","is_empty"],[20,3,1,"","k"],[20,2,1,"","merge"],[20,3,1,"","n"],[20,2,1,"","serialize"],[20,2,1,"","to_string"],[20,2,1,"","update"]],"datasketches.frequent_items_error_type":[[6,2,1,"","NO_FALSE_NEGATIVES"],[6,2,1,"","NO_FALSE_POSITIVES"]],"datasketches.frequent_items_sketch":[[6,1,1,"","__init__"],[6,1,1,"","deserialize"],[6,3,1,"","epsilon"],[6,1,1,"","get_apriori_error"],[6,1,1,"","get_epsilon_for_lg_size"],[6,2,1,"","get_estimate"],[6,2,1,"","get_frequent_items"],[6,2,1,"","get_lower_bound"],[6,2,1,"","get_serialized_size_bytes"],[6,2,1,"","get_upper_bound"],[6,2,1,"","is_empty"],[6,2,1,"","merge"],[6,3,1,"","num_active_items"],[6,2,1,"","serialize"],[6,2,1,"","to_string"],[6,3,1,"","total_weight"],[6,2,1,"","update"]],"datasketches.frequent_strings_sketch":[[6,1,1,"","__init__"],[6,1,1,"","deserialize"],[6,3,1,"","epsilon"],[6,1,1,"","get_apriori_error"],[6,1,1,"","get_epsilon_for_lg_size"],[6,2,1,"","get_estimate"],[6,2,1,"","get_frequent_items"],[6,2,1,"","get_lower_bound"],[6,2,1,"","get_serialized_size_bytes"],[6,2,1,"","get_upper_bound"],[6,2,1,"","is_empty"],[6,2,1,"","merge"],[6,3,1,"","num_active_items"],[6,2,1,"","serialize"],[6,2,1,"","to_string"],[6,3,1,"","total_weight"],[6,2,1,"","update"]],"datasketches.kll_doubles_sketch":[[16,1,1,"","__init__"],[16,1,1,"","deserialize"],[16,2,1,"","get_cdf"],[16,2,1,"","get_max_value"],[16,2,1,"","get_min_value"],[16,1,1,"","get_normalized_rank_error"],[16,2,1,"","get_pmf"],[16,2,1,"","get_quantile"],[16,2,1,"","get_quantiles"],[16,2,1,"","get_rank"],[16,2,1,"","is_empty"],[16,2,1,"","is_estimation_mode"],[16,3,1,"","k"],[16,2,1,"","merge"],[16,3,1,"","n"],[16,2,1,"","normalized_rank_error"],[16,3,1,"","num_retained"],[16,2,1,"","serialize"],[16,2,1,"","to_string"],[16,2,1,"","update"]],"datasketches.kll_floats_sketch":[[16,1,1,"","__init__"],[16,1,1,"","deserialize"],[16,2,1,"","get_cdf"],[16,2,1,"","get_max_value"],[16,2,1,"","get_min_value"],[16,1,1,"","get_normalized_rank_error"],[16,2,1,"","get_pmf"],[16,2,1,"","get_quantile"],[16,2,1,"","get_quantiles"],[16,2,1,"","get_rank"],[16,2,1,"","is_empty"],[16,2,1,"","is_estimation_mode"],[16,3,1,"","k"],[16,2,1,"","merge"],[16,3,1,"","n"],[16,2,1,"","normalized_rank_error"],[16,3,1,"","num_retained"],[16,2,1,"","serialize"],[16,2,1,"","to_string"],[16,2,1,"","update"]],"datasketches.kll_ints_sketch":[[16,1,1,"","__init__"],[16,1,1,"","deserialize"],[16,2,1,"","get_cdf"],[16,2,1,"","get_max_value"],[16,2,1,"","get_min_value"],[16,1,1,"","get_normalized_rank_error"],[16,2,1,"","get_pmf"],[16,2,1,"","get_quantile"],[16,2,1,"","get_quantiles"],[16,2,1,"","get_rank"],[16,2,1,"","is_empty"],[16,2,1,"","is_estimation_mode"],[16,3,1,"","k"],[16,2,1,"","merge"],[16,3,1,"","n"],[16,2,1,"","normalized_rank_error"],[16,3,1,"","num_retained"],[16,2,1,"","serialize"],[16,2,1,"","to_string"],[16,2,1,"","update"]],"datasketches.kll_items_sketch":[[16,1,1,"","__init__"],[16,1,1,"","deserialize"],[16,2,1,"","get_cdf"],[16,2,1,"","get_max_value"],[16,2,1,"","get_min_value"],[16,1,1,"","get_normalized_rank_error"],[16,2,1,"","get_pmf"],[16,2,1,"","get_quantile"],[16,2,1,"","get_quantiles"],[16,2,1,"","get_rank"],[16,2,1,"","is_empty"],[16,2,1,"","is_estimation_mode"],[16,3,1,"","k"],[16,2,1,"","merge"],[16,3,1,"","n"],[16,2,1,"","normalized_rank_error"],[16,3,1,"","num_retained"],[16,2,1,"","serialize"],[16,2,1,"","to_string"],[16,2,1,"","update"]],"datasketches.quantiles_doubles_sketch":[[17,1,1,"","__init__"],[17,1,1,"","deserialize"],[17,2,1,"","get_cdf"],[17,2,1,"","get_max_value"],[17,2,1,"","get_min_value"],[17,1,1,"","get_normalized_rank_error"],[17,2,1,"","get_pmf"],[17,2,1,"","get_quantile"],[17,2,1,"","get_quantiles"],[17,2,1,"","get_rank"],[17,2,1,"","is_empty"],[17,2,1,"","is_estimation_mode"],[17,3,1,"","k"],[17,2,1,"","merge"],[17,3,1,"","n"],[17,2,1,"","normalized_rank_error"],[17,3,1,"","num_retained"],[17,2,1,"","serialize"],[17,2,1,"","to_string"],[17,2,1,"","update"]],"datasketches.quantiles_floats_sketch":[[17,1,1,"","__init__"],[17,1,1,"","deserialize"],[17,2,1,"","get_cdf"],[17,2,1,"","get_max_value"],[17,2,1,"","get_min_value"],[17,1,1,"","get_normalized_rank_error"],[17,2,1,"","get_pmf"],[17,2,1,"","get_quantile"],[17,2,1,"","get_quantiles"],[17,2,1,"","get_rank"],[17,2,1,"","is_empty"],[17,2,1,"","is_estimation_mode"],[17,3,1,"","k"],[17,2,1,"","merge"],[17,3,1,"","n"],[17,2,1,"","normalized_rank_error"],[17,3,1,"","num_retained"],[17,2,1,"","serialize"],[17,2,1,"","to_string"],[17,2,1,"","update"]],"datasketches.quantiles_ints_sketch":[[17,1,1,"","__init__"],[17,1,1,"","deserialize"],[17,2,1,"","get_cdf"],[17,2,1,"","get_max_value"],[17,2,1,"","get_min_value"],[17,1,1,"","get_normalized_rank_error"],[17,2,1,"","get_pmf"],[17,2,1,"","get_quantile"],[17,2,1,"","get_quantiles"],[17,2,1,"","get_rank"],[17,2,1,"","is_empty"],[17,2,1,"","is_estimation_mode"],[17,3,1,"","k"],[17,2,1,"","merge"],[17,3,1,"","n"],[17,2,1,"","normalized_rank_error"],[17,3,1,"","num_retained"],[17,2,1,"","serialize"],[17,2,1,"","to_string"],[17,2,1,"","update"]],"datasketches.quantiles_items_sketch":[[17,1,1,"","__init__"],[17,1,1,"","deserialize"],[17,2,1,"","get_cdf"],[17,2,1,"","get_max_value"],[17,2,1,"","get_min_value"],[17,1,1,"","get_normalized_rank_error"],[17,2,1,"","get_pmf"],[17,2,1,"","get_quantile"],[17,2,1,"","get_quantiles"],[17,2,1,"","get_rank"],[17,2,1,"","is_empty"],[17,2,1,"","is_estimation_mode"],[17,3,1,"","k"],[17,2,1,"","merge"],[17,3,1,"","n"],[17,2,1,"","normalized_rank_error"],[17,3,1,"","num_retained"],[17,2,1,"","serialize"],[17,2,1,"","to_string"],[17,2,1,"","update"]],"datasketches.req_floats_sketch":[[18,1,1,"","__init__"],[18,1,1,"","deserialize"],[18,1,1,"","get_RSE"],[18,2,1,"","get_cdf"],[18,2,1,"","get_max_value"],[18,2,1,"","get_min_value"],[18,2,1,"","get_pmf"],[18,2,1,"","get_quantile"],[18,2,1,"","get_quantiles"],[18,2,1,"","get_rank"],[18,2,1,"","get_rank_lower_bound"],[18,2,1,"","get_rank_upper_bound"],[18,2,1,"","is_empty"],[18,2,1,"","is_estimation_mode"],[18,2,1,"","is_hra"],[18,3,1,"","k"],[18,2,1,"","merge"],[18,3,1,"","n"],[18,3,1,"","num_retained"],[18,2,1,"","serialize"],[18,2,1,"","to_string"],[18,2,1,"","update"]],"datasketches.req_ints_sketch":[[18,1,1,"","__init__"],[18,1,1,"","deserialize"],[18,1,1,"","get_RSE"],[18,2,1,"","get_cdf"],[18,2,1,"","get_max_value"],[18,2,1,"","get_min_value"],[18,2,1,"","get_pmf"],[18,2,1,"","get_quantile"],[18,2,1,"","get_quantiles"],[18,2,1,"","get_rank"],[18,2,1,"","get_rank_lower_bound"],[18,2,1,"","get_rank_upper_bound"],[18,2,1,"","is_empty"],[18,2,1,"","is_estimation_mode"],[18,2,1,"","is_hra"],[18,3,1,"","k"],[18,2,1,"","merge"],[18,3,1,"","n"],[18,3,1,"","num_retained"],[18,2,1,"","serialize"],[18,2,1,"","to_string"],[18,2,1,"","update"]],"datasketches.req_items_sketch":[[18,1,1,"","__init__"],[18,1,1,"","deserialize"],[18,1,1,"","get_RSE"],[18,2,1,"","get_cdf"],[18,2,1,"","get_max_value"],[18,2,1,"","get_min_value"],[18,2,1,"","get_pmf"],[18,2,1,"","get_quantile"],[18,2,1,"","get_quantiles"],[18,2,1,"","get_rank"],[18,2,1,"","get_rank_lower_bound"],[18,2,1,"","get_rank_upper_bound"],[18,2,1,"","is_empty"],[18,2,1,"","is_estimation_mode"],[18,2,1,"","is_hra"],[18,3,1,"","k"],[18,2,1,"","merge"],[18,3,1,"","n"],[18,3,1,"","num_retained"],[18,2,1,"","serialize"],[18,2,1,"","to_string"],[18,2,1,"","update"]],"datasketches.tdigest_double":[[19,1,1,"","__init__"],[19,2,1,"","compress"],[19,1,1,"","deserialize"],[19,2,1,"","get_cdf"],[19,2,1,"","get_max_value"],[19,2,1,"","get_min_value"],[19,2,1,"","get_pmf"],[19,2,1,"","get_quantile"],[19,2,1,"","get_rank"],[19,2,1,"","get_serialized_size_bytes"],[19,2,1,"","get_total_weight"],[19,2,1,"","is_empty"],[19,3,1,"","k"],[19,2,1,"","merge"],[19,2,1,"","serialize"],[19,2,1,"","to_string"],[19,2,1,"","update"]],"datasketches.tdigest_float":[[19,1,1,"","__init__"],[19,2,1,"","compress"],[19,1,1,"","deserialize"],[19,2,1,"","get_cdf"],[19,2,1,"","get_max_value"],[19,2,1,"","get_min_value"],[19,2,1,"","get_pmf"],[19,2,1,"","get_quantile"],[19,2,1,"","get_rank"],[19,2,1,"","get_serialized_size_bytes"],[19,2,1,"","get_total_weight"],[19,2,1,"","is_empty"],[19,3,1,"","k"],[19,2,1,"","merge"],[19,2,1,"","serialize"],[19,2,1,"","to_string"],[19,2,1,"","update"]],"datasketches.theta_a_not_b":[[3,1,1,"","__init__"],[3,2,1,"","compute"]],"datasketches.theta_intersection":[[3,1,1,"","__init__"],[3,2,1,"","get_result"],[3,2,1,"","has_result"],[3,2,1,"","update"]],"datasketches.theta_jaccard_similarity":[[9,1,1,"","dissimilarity_test"],[9,1,1,"","exactly_equal"],[9,1,1,"","jaccard"],[9,1,1,"","similarity_test"]],"datasketches.theta_sketch":[[3,2,1,"","get_estimate"],[3,2,1,"","get_lower_bound"],[3,2,1,"","get_seed_hash"],[3,2,1,"","get_upper_bound"],[3,2,1,"","is_empty"],[3,2,1,"","is_estimation_mode"],[3,2,1,"","is_ordered"],[3,3,1,"","num_retained"],[3,3,1,"","theta"],[3,3,1,"","theta64"],[3,2,1,"","to_string"]],"datasketches.theta_union":[[3,1,1,"","__init__"],[3,2,1,"","get_result"],[3,2,1,"","update"]],"datasketches.tuple_a_not_b":[[4,1,1,"","__init__"],[4,2,1,"","compute"]],"datasketches.tuple_intersection":[[4,1,1,"","__init__"],[4,2,1,"","get_result"],[4,2,1,"","has_result"],[4,2,1,"","update"]],"datasketches.tuple_jaccard_similarity":[[9,1,1,"","dissimilarity_test"],[9,1,1,"","exactly_equal"],[9,1,1,"","jaccard"],[9,1,1,"","similarity_test"]],"datasketches.tuple_sketch":[[4,2,1,"","DEFAULT_SEED"],[4,2,1,"","get_estimate"],[4,2,1,"","get_lower_bound"],[4,2,1,"","get_seed_hash"],[4,2,1,"","get_upper_bound"],[4,2,1,"","is_empty"],[4,2,1,"","is_estimation_mode"],[4,2,1,"","is_ordered"],[4,3,1,"","num_retained"],[4,3,1,"","theta"],[4,3,1,"","theta64"],[4,2,1,"","to_string"]],"datasketches.tuple_union":[[4,1,1,"","__init__"],[4,2,1,"","get_result"],[4,2,1,"","reset"],[4,2,1,"","update"]],"datasketches.update_theta_sketch":[[3,1,1,"","__init__"],[3,2,1,"","compact"],[3,2,1,"","reset"],[3,2,1,"","trim"],[3,2,1,"","update"]],"datasketches.update_tuple_sketch":[[4,1,1,"","__init__"],[4,2,1,"","compact"],[4,2,1,"","filter"],[4,2,1,"","reset"],[4,2,1,"","trim"],[4,2,1,"","update"]],"datasketches.var_opt_sketch":[[22,1,1,"","__init__"],[22,1,1,"","deserialize"],[22,2,1,"","estimate_subset_sum"],[22,2,1,"","get_serialized_size_bytes"],[22,2,1,"","is_empty"],[22,3,1,"","k"],[22,3,1,"","n"],[22,3,1,"","num_samples"],[22,2,1,"","serialize"],[22,2,1,"","to_string"],[22,2,1,"","update"]],"datasketches.var_opt_union":[[22,1,1,"","__init__"],[22,1,1,"","deserialize"],[22,2,1,"","get_result"],[22,2,1,"","get_serialized_size_bytes"],[22,2,1,"","reset"],[22,2,1,"","serialize"],[22,2,1,"","to_string"],[22,2,1,"","update"]]},"objnames":{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"],"3":["py","property","Python property"],"4":["py","function","Python function"]},"objtypes":{"0":"py:class","1":"py:method","2":"py:attribute","3":"py:property","4":"py:function"},"terms":{"":[1,6,20,21,22],"0":[3,4,5,6,10,16,17,18],"01668v2":18,"05":5,"1":[0,1,3,4,5,6,10,16,17,18,19],"10":[1,17],"100":17,"1000":17,"11":0,"12":[3,4,18],"128":17,"13":16,"14":6,"16":1,"18":6,"1982":6,"1985":2,"1e":6,"1e9":6,"2":[0,1,3,4,6,17,18],"20":17,"200":[16,19],"2002":6,"2003":6,"2004":18,"2006":6,"2021":17,"2023":20,"21":1,"3":[0,1,3,4,6,17,18],"30":17,"32":12,"33":16,"4":[1,12,17],"40":17,"47":16,"483":17,"5":[5,6,17],"500":17,"50th":17,"517":17,"6":1,"64":[0,3,4,5,12,17],"65":16,"7":[1,9,17],"75":6,"8":[1,6,12],"80":11,"900":17,"9001":[0,3,4,9],"93smirnov_test":11,"95":[5,17],"95th":17,"97":9,"99":[16,17],"A":[1,3,4,6,10,11,12,13,16,17,22],"As":[0,17],"For":[0,1,5,6,16,17,18,19,24],"If":[1,6,9,16,17,18,19],"In":[0,1,16,20],"It":[3,16,17,18,19],"One":2,"That":15,"The":[0,1,2,3,4,5,6,7,10,11,12,13,15,16,17,18,19,20,21,22,23],"Then":16,"There":[3,6],"These":[1,8,9,15,21,24],"With":[16,17,18],"_":11,"__call__":[10,13],"__eq__":6,"__hash__":6,"__init__":[0,1,3,4,6,16,17,18,19,20,22,23],"__lt__":[16,17,18],"_datasketch":[0,1,3,4,5,6,9,11,16,17,18,19,20,22,23],"ab":18,"abbadi":6,"abil":18,"about":[1,15,16,17],"abov":[7,16],"absolut":8,"abstract":[3,4,8,10,12,13],"accept":24,"account":11,"accumulatori":13,"accumulatorpolici":13,"accur":19,"accuraci":[0,1,2,3,5,6,16,17,18,19],"achiev":5,"activ":[6,14],"actual":[9,17],"ad":13,"add":16,"addit":[0,2,6,12],"addition":16,"advanc":21,"affect":[16,17],"after":[18,21],"against":[0,9],"agraw":6,"algorithm":[0,1,2,3,6,14,18,19],"all":[1,3,6,12,13,15,16,17,19,20,22],"alloc":12,"allow":[0,4,12,13,18],"along":6,"also":[0,3,10,14,15,17,19],"altern":[15,19],"although":[1,19,20],"alwai":[6,13,16,17,20,21],"an":[0,1,2,3,4,5,6,7,9,10,12,13,15,16,17,18,19,20,21,22,23],"analog":[16,17,18,19],"analysi":[4,11,16,17,18],"analyz":14,"ani":[3,4,5,6,7,13,16,17],"anoth":[0,6,18],"answer":15,"appl":0,"appli":[2,3,4,6,13,15,16,18,21,22],"applic":2,"approach":15,"approx":[5,18],"approxim":[0,1,3,4,5,6,10,15,16,17,18,19,23],"ar":[0,1,3,4,5,6,8,9,11,12,13,14,15,16,17,18,19,21,24],"arbitrari":[4,6],"arg":[0,1,3,4,5,6,10,12,13,16,17,18,19,20,22,23],"arg0":3,"arg1":3,"around":16,"arrai":[6,10,16,17,18,19],"art":2,"arxiv":18,"as_pmf":[16,17],"associ":[4,6,16,17,18,19],"assum":[6,11],"avail":16,"avoid":3,"axi":16,"b":[3,4,10,20],"back":0,"background":6,"backward":[6,15],"bag":6,"bandwidth":10,"base":[0,1,2,3,4,5,6,8,10,12,13,15,18,19,20,21,23],"basi":[10,19],"basic":[3,4,10],"becaus":16,"been":[7,16,17,18,22],"befor":[6,7],"behavior":1,"being":21,"below":16,"best":[16,17],"better":[1,2,3],"between":[1,3,4,6,8,9,16,17,18,23],"beyond":3,"bias":19,"big":14,"bin":[0,16],"binari":[12,17],"bit":[0,1,3,4,5,12,17],"blob":23,"bool":[1,3,4,9,11,16,17,18],"both":[11,18,19,21],"bound":[0,1,3,4,5,6,9,14,15,16,18,21,22],"bracket":16,"bucket":[1,5],"buffer":19,"build":23,"byte":[0,1,3,4,5,6,12,16,17,18,19,20,22,23],"c":[0,20],"call":[16,20],"came":2,"can":[0,1,3,4,6,11,13,15,16,17,18,19],"cannot":16,"capabl":[0,6,18],"capac":6,"cardin":[0,3],"case":[1,6,8,17,20],"caus":6,"cdf":[15,16,17,18,19],"centroid":19,"certain":[7,8,10,16,20],"characterist":19,"choic":1,"choos":18,"chosen":19,"class":[0,1,3,4,5,6,9,10,12,13,16,17,18,19,20,22,23],"classic":[15,17],"close":[7,19],"closest":19,"cm":5,"code":[6,18],"collect":1,"com":23,"combin":[8,13],"come":[11,17],"common":19,"commonli":[6,16],"compact":[1,3,4,15,16,18],"compact_theta_sketch":3,"compact_tuple_sketch":4,"compactor":18,"compar":[0,16,17,18],"comparison":[0,18],"compat":[6,12,15,17],"complic":4,"compress":[1,2,3,14,19],"comput":[3,4,6,8,9,15,19,20,22,23],"concept":2,"concret":8,"confid":[5,9,16,17],"configur":[0,1,5,16,17,18,19,20,22,23],"consecut":[16,17,18,19],"consid":[9,17],"consist":13,"constant":[1,6,16,17,18],"construct":[1,18,22],"consum":[1,12],"contain":[3,6,7],"context":10,"contrast":[5,20],"control":[16,17,18,19,23],"coreset":23,"cormod":[5,18],"correspond":[0,1,3,4,5,6,16,17,18,20,22,23],"cost":[1,12],"could":[16,17,18],"count":[1,3,4,6,17,18],"count_min_sketch":[5,7],"counter":6,"countmin":[7,14],"coupon":1,"cpc":[1,2,14],"cpc_sketch":[0,2],"cpc_union":0,"creat":[0,3,4,6,13,16,17,18,19,20,22,23],"create_summari":13,"creation":20,"criterion":18,"critic":12,"cross":[12,17],"cumul":[15,16,17,18,19],"current":[1,3,4,5,6,7,11,15,20,22],"custom":[4,10,12,13],"data":[2,3,6,11,12,13,14,15,16,17,18,19,20,22,23],"datasketch":[2,11,19],"datum":[0,1,3,4],"debug":18,"decreas":[15,18],"decrement":6,"dedic":[3,4],"default":[1,3,4,10,16,17,18,19],"default_se":4,"defin":[3,4,6,10,16,20],"definit":[16,17,18],"delta":5,"demain":6,"denot":[5,6],"densiti":[8,10,14,24],"density_sketch":[10,23,24],"depend":[5,16,19],"deprec":[14,15],"derial":19,"deriv":[3,16,17,18],"describ":[0,5,18,19],"deseri":[0,1,3,4,5,6,8,14,16,17,18,19,20,22,23],"design":[15,24],"desing":22,"detail":[18,21],"determin":[7,11],"determinist":6,"develop":[0,14],"deviat":[0,1,3,4,18],"differ":[0,1,2,3,6,12,13,18,19,21],"digest":[14,15],"dim":23,"dimac":5,"dimens":[0,23],"dimension":16,"discov":6,"discrep":23,"discuss":18,"disjoint":[16,17,18,19],"dissimilar":9,"dissimilarity_test":9,"distanc":23,"distinct":[0,1,3,4,6],"distribut":[1,11,15,16,17,18,19],"divid":[16,17,18,19],"do":[6,19],"document":16,"doe":[0,5,6,7,15,16,18,19,21],"domain":[16,19],"doubl":[16,17,18,20],"dtype":[16,17,18,19],"dun":19,"dure":1,"e":15,"e2":11,"each":[1,2,4,6,11,12,13,16,17,18,21],"earliest":2,"easili":[3,4],"ebpp":[14,21],"ebpps_sketch":[20,21],"edg":[16,17],"edo":[18,23],"edoliberti":23,"edu":5,"effect":[3,4,19],"effici":[0,3,6,14],"either":[6,15,16,17,18,19],"element":[2,6],"els":18,"empir":[0,16,17,18,19],"emploi":6,"empti":[0,1,3,4,6,16,17,18,19,20,22,23],"en":11,"enabl":[16,17],"encod":12,"end":[15,19],"endian":12,"enough":1,"ensur":[6,20,21],"entir":[7,15,21],"entri":[1,3,4,6],"entropi":0,"ep":16,"epsilon":[6,16],"equal":[11,15,16,17,18,20],"equival":[9,17,20,22],"error":[1,3,5,6,8,11,14,15,16,17,19,20,22,23],"ertl":19,"estim":[0,1,2,3,4,5,6,7,8,9,10,15,16,17,18,19,22,23,24],"estimate_subset_sum":22,"estimated_total_stream_weight":6,"estimated_total_weight":6,"evalu":[4,10],"even":[0,21],"everi":[3,4,5,6],"exact":[6,14,21],"exactli":[20,21],"exactly_equ":9,"exampl":[4,5,6,8,10,12,17],"exce":[6,18,20],"excel":19,"except":[1,16,17,18],"excess":[3,4],"exclud":6,"exclus":[16,17,18],"exist":[3,4,13],"expect":[9,20],"expens":6,"express":18,"extend":[12,13],"extens":[4,18],"extern":6,"extrem":[0,6,19],"f688c8161a25582457b0a09deb4630a81406293b":23,"f_x":5,"factor":18,"failur":5,"fals":[0,1,3,4,5,6,9,11,16,17,18,19,20,22,23],"famili":[1,8,11,19],"far":[6,15,16,17,18,19,20],"fast":0,"favor":[15,17],"fed":1,"feed":[20,22],"few":[4,19],"fewer":[6,20,22],"field":6,"filter":4,"find":6,"fit":[16,17],"fix":4,"flag":[16,17],"flajolet":[1,2],"flavor":[1,6],"float":[0,1,3,4,5,6,9,10,11,12,15,16,17,18,19,20],"float32":[16,17,18,19],"float64":[16,17,19],"fm85":0,"follow":[6,16,18,23],"footprint":2,"form":[3,4,6,11],"format":[12,19],"found":6,"four":15,"fraction":[3,4,16,17,20],"framework":3,"frequenc":[5,6,17],"frequent":[5,7,14],"frequent_items_error_typ":6,"frequent_items_sketch":[6,7],"frequent_strings_sketch":[6,7],"from":[2,3,4,6,7,10,11,12,16,17,18,19,20,21,22,23],"from_byt":12,"full":[1,5],"funciton":10,"function":[0,1,3,4,5,6,8,11,14,15,16,17,18,19],"futur":0,"g":15,"gaussian":10,"gaussiankernel":10,"gde":23,"gener":[6,7,10,15,16,17,18],"get":[16,17],"get_apriori_error":6,"get_cdf":[16,17,18,19],"get_compact_serialization_byt":1,"get_epsilon_for_lg_s":6,"get_estim":[0,1,3,4,5,6,23],"get_frequent_item":6,"get_lower_bound":[0,1,3,4,5,6],"get_max_updatable_serialization_byt":1,"get_max_valu":[16,17,18,19],"get_min_valu":[16,17,18,19],"get_n":17,"get_normalized_rank_error":[16,17,18],"get_pmf":[16,17,18,19],"get_quantil":[16,17,18,19],"get_rank":[16,17,18,19],"get_rank_lower_bound":18,"get_rank_upper_bound":18,"get_rel_err":1,"get_relative_error":5,"get_result":[0,1,3,4,20,22],"get_rs":18,"get_seed_hash":[3,4],"get_serialized_size_byt":[5,6,19,20,22],"get_siz":12,"get_total_weight":19,"get_updatable_serialization_byt":1,"get_upper_bound":[0,1,3,4,5,6],"github":23,"given":[0,1,3,4,5,6,10,11,12,15,16,17,18,19,20,22,23],"global":[6,15],"good":[2,3,15],"graham":[5,18],"gri":6,"grow":6,"guarante":[5,6,15,16,17,18],"ha":[1,3,4,5,7,16,17,18,19],"haa":20,"handl":[3,7,20],"has_result":[3,4],"hash":[0,3,4,5,6],"hat":5,"have":[1,6,11,15,16,17,18,22],"heavi":[5,6,7,14],"heaviest":7,"help":[9,18],"hentschel":20,"here":18,"heurist":15,"hi":0,"high":[0,1,15,18,19],"higher":[1,17],"highest":1,"highli":14,"hip":0,"histogram":[15,17],"histor":[0,15],"hitter":[5,6,7,14],"hll":[0,2,14],"hll_4":1,"hll_6":1,"hll_8":1,"hll_sketch":[1,2],"hll_union":1,"hold":[1,6,19],"how":[4,7,8,13,18],"howev":[6,16,18,19],"http":[5,11,18,23],"hyper":2,"hyperloglog":[0,2,3,14],"hypothesi":11,"hypothet":[16,17,18,19],"i":[0,1,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,22,23],"icon":0,"identifi":7,"imag":5,"implement":[0,1,4,6,7,10,12,13,16,17,18,19,23],"improv":[1,22],"includ":[15,16,17,18,19,20,21,22],"inclus":[1,16,17,18,21],"incom":[3,4,6],"increas":[16,17,18,19],"increment":6,"independ":16,"index":[9,14,16,17],"indic":[1,10],"inform":[19,20],"inherit":10,"init_number_of_sect":18,"initi":[1,3,4,6,18],"input":[0,1,3,4,6,10,11,16,17,18,19,21,23,24],"insert":[3,5,6],"inspir":23,"instanc":[6,16,17,18,19,20,22,23],"instead":[17,18],"insuffici":11,"int":[0,1,3,4,5,6,9,12,16,17,18,19,20,22,23],"int32":[16,17,18],"integ":[0,5,6,12,13,15],"integr":[1,3,4],"intern":6,"internet":6,"interpol":19,"interpret":16,"intersect":[2,3,4,13],"interv":[16,17,18,19],"introduc":6,"invers":[0,16],"involv":7,"is_compact":1,"is_empti":[0,1,3,4,5,6,16,17,18,19,20,22,23],"is_estimation_mod":[3,4,16,17,18,23],"is_hra":18,"is_ord":[3,4],"item":[1,3,4,5,7,12,14,15,16,17,18,19,20,21,22,23],"iter":20,"its":[0,12,16,17,19,20],"itself":6,"j":20,"j_":9,"jaccard":[3,4,8,14],"java":17,"job":15,"just":16,"justin":18,"k":[0,1,2,3,4,6,7,16,17,18,19,20,22,23],"kappa":0,"karnin":[18,23],"karnin19a":23,"karp":6,"keep":[1,4,20],"kei":[2,4],"kept":13,"kernel":[8,14,23,24],"kernel_funct":8,"kernel_sketch":8,"kernelfunct":[10,23],"kevin":0,"kll":[14,15,17],"kll_doubles_sketch":[11,16],"kll_floats_sketch":[11,16],"kll_ints_sketch":[11,16],"kll_items_sketch":[11,16],"known":[0,2,6,10,14,21],"kolmogorov":[8,14],"ks_test":[8,11],"kwarg":[0,1,3,4,5,6,10,12,13,16,17,18,19,20,22,23],"lang":0,"languag":[12,17],"larg":[1,15,16,17],"larger":[2,16,20],"largest":13,"last":[16,17,18],"lazi":16,"lb":[6,9],"le":5,"learn":[10,23],"least":[6,8],"left":[16,17,18],"legaci":6,"lemma":18,"len":12,"length":[6,16,17,18,20,21,22,23],"less":[15,16,17,18],"let":16,"letter":20,"level":[5,18],"leverag":1,"lg_config_k":1,"lg_k":[0,1,3,4],"lg_max_k":[1,6],"lg_max_map_s":6,"liberti":[18,23],"librari":[2,4,6,7,10,11,15,19,24],"like":[1,7,11,16],"limit":[6,20],"line":[16,17,18,19],"list":[5,7,9],"littl":12,"load_factor":6,"log":[1,2],"log2":[1,6],"logarithm":[0,3,4,6],"logic":[6,15],"longer":2,"look":6,"loos":18,"lopez":6,"low":[15,18,19],"lower":[0,1,3,4,5,6,9,16,18,19,22],"lower_bound":9,"m":[6,16,17,18,19],"machin":[10,23],"mai":[5,6,14,15,16,18,20],"maintain":[3,7],"make":16,"mani":[3,19],"map":6,"mapcap":6,"mapsiz":6,"margin":20,"martin":2,"mass":[15,16,17,18,19],"mass_i":16,"match":[0,3,4,22],"mathemat":[10,18,19],"max":[13,16,17,18,19],"max_k":22,"max_map_s":6,"maximum":[1,3,4,5,6,16,17,18,19,20,22],"maxintpolici":13,"maxmapcap":6,"maxmaps":6,"mean":[4,6,16,17,20],"measur":[3,4,9,16,17,18,19],"median":[6,17,19],"member":[3,6],"memori":[1,2,6],"merg":[0,1,4,5,6,16,17,18,19,20,23],"mergingdigest":19,"method":[0,1,3,4,5,6,10,12,16,17,18,19,20,22,23],"metwal":6,"middl":19,"might":[6,16],"million":17,"min":[13,16,17,18,19],"minim":21,"minimum":[2,3,16,17,18,19,22],"minintpolici":13,"misra":6,"miss":6,"mlr":23,"mode":[1,3,4,16,17,18,23],"modifi":[11,18,19],"modul":14,"monoton":[16,17,18,19],"more":[0,6,19],"most":[7,17],"much":[1,6],"multipli":17,"multiset":6,"munro":6,"must":[1,3,4,10,12,13,16,17,18],"muthukrishnan":5,"n":[1,16,17,18,20,22,23],"name":6,"nan":[16,17,18],"natur":[16,17],"ndarrai":[16,17,18,19],"nearli":[0,16],"necessari":[16,17,18,19],"necessarili":7,"necesssari":19,"need":[3,5,6,13,20,21,22],"network":17,"never":[5,6,16,18],"new":[0,1,6,13,17,20,22,23],"newli":0,"no_false_neg":6,"no_false_posit":6,"node":17,"nomin":[3,4,18],"non":[0,1,3,4,5,6,16,17,18,19,20,22,23],"none":[0,1,3,4,5,6,16,17,18,19,20,22,23],"normal":[16,17,18,19],"normalized_rank_error":[16,17],"note":[6,9,11,16,18],"novemb":17,"now":24,"null":[11,12],"num_active_item":6,"num_bucket":5,"num_byt":12,"num_hash":5,"num_retain":[3,4,16,17,18,23],"num_sampl":22,"num_std_dev":1,"number":[0,1,2,3,4,5,6,12,16,17,18,19,20,22,23],"numer":[15,19,20],"numpi":10,"numsect":18,"object":[0,1,3,4,5,6,7,9,10,12,13,16,17,18,19,20,22,23],"obtain":[5,16,17,18],"occurr":5,"off":[1,2,16,17,18,19],"offer":[1,2,7],"offest":12,"offset":12,"often":7,"one":[2,5,6,7,8,16,17,18,19,23],"onli":[1,6,15,16,17,18,19,24],"oper":[0,2,3,4,13,16,18,19],"opposit":16,"opt":22,"optim":[0,14,16,21],"option":[0,3,4,6,16,17,18,19,20,22],"order":[3,4,5,13,15,20],"org":[11,18],"ortiz":6,"other":[3,4,5,16,17,19],"otherwis":[0,1,3,4,5,6,9,11,16,17,18,19,20,22,23],"otmar":19,"our":6,"output":18,"outsid":7,"over":[6,15,17],"overal":17,"overestim":[5,19],"overload":[0,1,3,4,5,11,16,17,18,19],"overrid":[10,12],"p":[3,4,11,20],"packag":3,"packet":[6,17],"page":[14,19],"pair":[6,8,11],"papadimitri":6,"paper":[0,3,5,18,19,23],"paramet":[0,1,3,4,5,6,10,12,13,16,17,18,19,20,22,23],"partial":20,"particular":18,"particularli":10,"pass":[16,17],"pattern":10,"pavel":18,"pdf":[5,23],"per":[1,16],"percentag":7,"percentil":[16,17],"perform":[0,1,2,3,4,8,10,11,16,18,19],"permiss":5,"phillip":1,"physic":6,"plot":16,"plu":6,"pmf":[15,16,17,18,19],"point":[0,1,3,4,10,12,15,16,17,18,19,20,23],"polici":[4,8,14],"portion":[15,20],"posit":6,"possibl":0,"power":[6,18],"pp":20,"practic":[3,6],"pre":12,"precis":[17,20],"predic":[4,21,22],"present":22,"press":23,"print":[20,22],"priori":[1,6,18],"priorit":19,"probabilist":[1,2,5,14,15,16,17,18],"probabilitii":[14,21],"probabl":[0,5,6,15,16,17,18,19,20,21,22],"problem":14,"proceed":23,"process":[19,20,22],"produc":[0,1,3,4,5,6,16,17,18,19,20,22,23],"project":[14,17],"pronounc":19,"proof":6,"properti":[0,1,2,3,4,5,6,15,16,17,18,19,20,22,23],"proport":[14,21],"prototyp":18,"proven":15,"provid":[0,1,2,3,4,5,6,7,9,10,11,12,13,15,16,17,18,19,22,23,24],"pub":5,"purg":6,"py":23,"pydoublesserd":12,"pyfloatsserd":12,"pyintsserd":12,"pylongsserd":12,"pyobjectserd":[4,6,12,16,17,18,20,22],"pystringsserd":12,"python":[13,18],"q":16,"q_hi":16,"q_lo":16,"qualifi":6,"quantil":[8,16,19,23],"quantiles_doubles_sketch":[11,17],"quantiles_floats_sketch":[11,17],"quantiles_ints_sketch":[11,17],"quantiles_items_sketch":[11,17],"queri":[5,15,16,17,22],"quickli":14,"quit":[0,4,15,16],"r":16,"r1":16,"r2":16,"r_":16,"r_i":16,"radial":10,"random":[6,20],"randomli":21,"rang":15,"rank":[15,16,17,18,19],"rate":[3,4],"reach":[1,6],"read":[0,1,3,4,5,6,12,19,20,22,23],"real":[16,17,18,19],"reason":1,"rebuild":6,"receiv":[1,17],"recognit":10,"recommend":1,"reconstruct":12,"redesign":6,"rediscov":6,"refer":[6,8,12,16,19],"reflect":11,"regardless":7,"reject":11,"rel":[1,5,7,14,15,20,21,22],"relat":[7,9,20,22],"relationship":16,"relative_error":5,"relev":13,"reli":10,"remain":18,"remov":[3,4,6],"repeat":6,"repres":[1,17,20],"req":[14,15,17,19],"req_floats_sketch":18,"req_ints_sketch":18,"req_items_sketch":18,"requir":[4,5,6,8,16,17,18,20,22,23],"reservoir":[20,22],"reset":[1,3,4,22],"respect":[16,17],"result":[0,3,4,6,16,17,18,19,21,22],"retain":[3,4,6,16,17,18,23],"retun":12,"return":[0,1,3,4,5,6,9,10,11,12,13,16,17,18,19,20,22,23],"right":[4,16,17,18],"roughli":[0,22],"round":18,"row":1,"rse":18,"rule":13,"run":6,"runtimeerror":[16,17,18,19],"rutger":5,"s1":16,"s2":16,"s_i":16,"s_m":16,"same":[1,3,11],"sampl":[3,4,16,17,18,23],"satisfi":5,"scheme":[12,16],"score":10,"search":14,"section":18,"section_s":18,"secur":0,"see":[16,19],"seed":[0,3,4,5,9],"seem":[16,19],"seen":[5,6,7,15,19,20],"select":4,"self":[0,1,3,4,5,6,10,12,13,16,17,18,19,20,22,23],"semin":2,"separ":[3,9,16,17,18],"serd":[4,6,8,14,16,17,18,20,22],"serial":[0,1,3,4,5,6,8,14,16,17,18,19,20,22,23],"serialize_compact":1,"serialize_updat":1,"set":[2,3,4,6,13,16,17,18,19,23],"sever":[2,3,4,6,12],"shenker":6,"should":[13,16,20],"show":19,"shown":16,"side":[16,17,19],"significantli":1,"similar":[2,3,4,8,10,13,14,19],"similarity_test":9,"similarli":17,"simpl":[2,3,6,12],"simultan":0,"sinc":[6,18],"singl":[16,17],"size":[1,3,4,5,6,11,12,14,16,17,18,19,21,22,23],"sk_1":11,"sk_2":11,"skech":18,"sketch":[0,1,2,6,8,9,11,12,19,20,22],"sketch_a":9,"sketch_b":9,"slightli":19,"slot":1,"sm":16,"small":[1,6,11,15],"smaller":[0,1,6,16,22],"smallest":13,"smirnov":[8,14],"snly":7,"so":[0,6,15,16,17,18,19,20],"solut":2,"some":[6,8,16],"sometim":16,"somewhat":[2,21],"sort":[3,4,16,17,18,19],"sourc":[3,4],"sourch":4,"space":[0,1,2,3,6],"special":18,"specif":[6,8,10,15,16,17],"specifi":[0,1,5,6,8,12,13,16,18],"speed":[0,6],"split":[16,17,18,19],"split_point":[16,17,18,19],"sqrt":18,"standard":[0,1,3,4,18],"start":[1,6,12,18],"start_full_s":1,"start_max_s":1,"state":[1,2,3,4,6,18,22],"static":[0,1,3,4,5,6,16,17,18,19,20,22,23],"still":19,"stochast":[16,17],"storag":[1,12,15],"store":[2,3,6],"str":[0,1,3,4,5],"straightforward":15,"stream":[0,1,3,4,5,6,7,15,16,17,18,19,20,21,22,23],"strictli":20,"string":[0,1,3,4,5,6,7,12,16,17,18,19,20,22,23],"string_cont":12,"subset":[21,22],"subtract":16,"suggest":5,"suggest_num_bucket":5,"suggest_num_hash":5,"sum":[6,16,17,18,21,22],"summari":[0,1,3,4,5,6,8,13,16,17,18,19,20,22,23],"support":[2,6,19],"surviv":0,"t":[14,15,17],"tabl":[1,6],"take":11,"target":1,"target_hll_typ":1,"task":2,"tdigest":19,"tdigest_doubl":19,"tdigest_float":19,"ted":19,"templat":17,"tend":19,"term":1,"termin":12,"test":[8,9,14],"tgt_hll_type":1,"tgt_type":1,"thaler":18,"than":[0,1,2,3,6,15,16,17,18,20],"thei":[4,11,15,21],"them":8,"theta":[1,2,4,8,9,14],"theta64":[3,4],"theta_a_not_b":3,"theta_intersect":3,"theta_jaccard_similar":[3,9],"theta_sketch":[2,3,4,9],"theta_union":3,"thi":[0,1,4,5,6,11,12,13,14,16,17,18,19,20,22,23],"those":[7,8,15],"thousand":[16,17],"three":[1,12,15],"threshold":9,"through":[3,4,6],"throw":[16,17,18,19],"thu":[16,18],"tian":20,"tight":18,"time":[1,6,16,17,18],"to_byt":12,"to_str":[0,1,3,4,5,6,16,17,18,19,20,22,23],"too":[6,11],"tool":18,"top":[6,7],"topk":14,"total":[5,17,18,19,20,22],"total_weight":[5,6],"toward":19,"track":6,"trade":[1,2,16,17,18,19],"tradeoff":0,"translat":16,"trial":[16,17],"trim":[3,4],"true":[0,1,3,4,5,6,9,11,16,17,18,19,20,22,23],"true_mass":16,"true_rank":16,"tupl":[2,3,8,9,12,14],"tuple_a_not_b":[3,4],"tuple_intersect":4,"tuple_jaccard_similar":[4,9],"tuple_polici":8,"tuple_sketch":[2,4,8,9,13],"tuple_union":4,"tuplepolici":[4,13],"two":[0,6,7,10,11,16,18,23],"type":[1,2,4,6,7,10,11,12,13,15],"typic":[6,15],"u":16,"ub":[6,9],"under":14,"underestim":[5,19],"underli":11,"understand":[15,18],"unequ":20,"uniform":[15,20,22],"union":[0,1,3,4,13,22],"uniqu":[0,1,2,16,17,18,19],"unlik":19,"unsurprisingli":10,"up":[1,6],"updat":[0,1,3,4,5,6,13,16,17,18,19,20,22,23],"update_summari":13,"update_theta_sketch":3,"update_tuple_sketch":4,"upon":20,"upper":[0,1,3,4,5,6,9,16,18,22],"upper_bound":[1,9],"us":[1,3,4,5,6,8,9,10,11,12,13,15,16,17,18,19,20,21,22,23],"usag":6,"user":[0,10,18],"usual":6,"v99":23,"valid":[3,4,18],"valu":[0,1,2,3,4,5,6,10,11,12,13,15,16,17,18,19,20,22],"var":22,"var_opt_sketch":[21,22],"var_opt_union":22,"variabl":[6,18],"varianc":[14,21],"variant":[3,6,7],"varopt":[14,20,21],"vector":[10,16,17,18,19,23],"veri":[4,6,15,16,17,19],"version":[1,6,7,12,15,16,17,18,19],"vesel\u00fd":18,"via":18,"view":16,"visibl":18,"w":6,"warmup":1,"we":[6,11,16,18],"weight":[5,6,7,16,17,18,19,20,21,22],"well":[0,2,15,19,22],"were":[2,6,16,17],"what":[6,15],"when":[0,1,3,4,5,8,13,15,17,18,22],"where":[1,6,12,13,16,20],"whether":[1,3,4,18],"which":[2,3,4,5,6,7,10,12,15,16,17,18,19],"while":[2,3,15,19],"whose":7,"wiki":11,"wikipedia":11,"win":0,"within":[5,8],"without":15,"work":[2,15,17,18],"wors":16,"worst":6,"would":6,"written":[12,18],"x":[5,16],"y":[16,20],"year":6,"yield":16,"you":17,"zero":16,"zohar":[18,23]},"titles":["Compressed Probabilistic Counting (CPC)","HyperLogLog (HLL)","Distinct Counting","Theta Sketch","Tuple Sketch","CountMin Sketch","Frequent Items","Frequency Sketches","Helper Classes","Jaccard Similarity","Kernel Function","Kolmogorov-Smirnov Test","Serialize/Deserialize (SerDe)","Tuple Policy","Apache DataSketches","Quantiles Sketches","KLL Sketch","Quantiles Sketch (Deprecated)","Relative Error Quantiles (REQ) Sketch","t-digest","Exact and Bounded, Probabilitiy Proportional to Size (EBPPS) Sampling","Random Sampling Sketches","Variance Optimal Sampling (VarOpt)","Density Sketch","Vector Sketches"],"titleterms":{"apach":14,"bound":20,"class":[8,14],"compress":0,"count":[0,2,14],"countmin":5,"cpc":0,"datasketch":14,"densiti":23,"deprec":17,"deseri":12,"digest":19,"distinct":[2,14],"ebpp":20,"error":18,"estim":14,"exact":20,"frequenc":[7,14],"frequent":6,"function":10,"helper":[8,14],"hll":1,"hyperloglog":1,"indic":14,"item":6,"jaccard":9,"kernel":10,"kll":16,"kolmogorov":11,"optim":22,"polici":13,"probabilist":0,"probabilitii":20,"proport":20,"quantil":[14,15,17,18],"random":[14,21],"rel":18,"req":18,"sampl":[14,20,21,22],"serd":12,"serial":12,"similar":9,"size":20,"sketch":[3,4,5,7,14,15,16,17,18,21,23,24],"smirnov":11,"t":19,"tabl":14,"test":11,"theta":3,"tupl":[4,13],"varianc":22,"varopt":22,"vector":[14,24]}}) \ No newline at end of file +Search.setIndex({"alltitles":{"Apache DataSketches":[[14,null]],"Compressed Probabilistic Counting (CPC)":[[0,null]],"CountMin Sketch":[[5,null]],"Counting Distincts":[[14,"counting-distincts"]],"Density Sketch":[[23,null]],"Distinct Counting":[[2,null]],"Exact and Bounded, Probabilitiy Proportional to Size (EBPPS) Sampling":[[20,null]],"Frequency Sketches":[[7,null],[14,"frequency-sketches"]],"Frequent Items":[[6,null]],"Helper Classes":[[8,null],[14,"helper-classes"]],"HyperLogLog (HLL)":[[1,null]],"Indices and tables":[[14,"indices-and-tables"]],"Jaccard Similarity":[[9,null]],"KLL Sketch":[[16,null]],"Kernel Function":[[10,null]],"Kolmogorov-Smirnov Test":[[11,null]],"Quantile Estimation":[[14,"quantile-estimation"]],"Quantiles Sketch (Deprecated)":[[17,null]],"Quantiles Sketches":[[15,null]],"Random Sampling":[[14,"random-sampling"]],"Random Sampling Sketches":[[21,null]],"Relative Error Quantiles (REQ) Sketch":[[18,null]],"Serialize/Deserialize (SerDe)":[[12,null]],"Theta Sketch":[[3,null]],"Tuple Policy":[[13,null]],"Tuple Sketch":[[4,null]],"Variance Optimal Sampling (VarOpt)":[[22,null]],"Vector Sketches":[[14,"vector-sketches"],[24,null]],"t-digest":[[19,null]]},"docnames":["distinct_counting/cpc","distinct_counting/hyper_log_log","distinct_counting/index","distinct_counting/theta","distinct_counting/tuple","frequency/count_min_sketch","frequency/frequent_items","frequency/index","helper/index","helper/jaccard","helper/kernel","helper/ks_test","helper/serde","helper/tuple_policy","index","quantiles/index","quantiles/kll","quantiles/quantiles_depr","quantiles/req","quantiles/tdigest","sampling/ebpps","sampling/index","sampling/varopt","vector/density_sketch","vector/index"],"envversion":{"sphinx":66,"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},"filenames":["distinct_counting/cpc.rst","distinct_counting/hyper_log_log.rst","distinct_counting/index.rst","distinct_counting/theta.rst","distinct_counting/tuple.rst","frequency/count_min_sketch.rst","frequency/frequent_items.rst","frequency/index.rst","helper/index.rst","helper/jaccard.rst","helper/kernel.rst","helper/ks_test.rst","helper/serde.rst","helper/tuple_policy.rst","index.rst","quantiles/index.rst","quantiles/kll.rst","quantiles/quantiles_depr.rst","quantiles/req.rst","quantiles/tdigest.rst","sampling/ebpps.rst","sampling/index.rst","sampling/varopt.rst","vector/density_sketch.rst","vector/index.rst"],"indexentries":{"__call__() (kernelfunction method)":[[10,"datasketches.KernelFunction.__call__",false]],"__call__() (tuplepolicy method)":[[13,"datasketches.TuplePolicy.__call__",false]],"__init__() (compact_theta_sketch method)":[[3,"datasketches.compact_theta_sketch.__init__",false]],"__init__() (compact_tuple_sketch method)":[[4,"datasketches.compact_tuple_sketch.__init__",false]],"__init__() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.__init__",false]],"__init__() (cpc_union method)":[[0,"datasketches.cpc_union.__init__",false]],"__init__() (density_sketch method)":[[23,"datasketches.density_sketch.__init__",false]],"__init__() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.__init__",false]],"__init__() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.__init__",false]],"__init__() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.__init__",false]],"__init__() (hll_sketch method)":[[1,"datasketches.hll_sketch.__init__",false]],"__init__() (hll_union method)":[[1,"datasketches.hll_union.__init__",false]],"__init__() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.__init__",false]],"__init__() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.__init__",false]],"__init__() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.__init__",false]],"__init__() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.__init__",false]],"__init__() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.__init__",false]],"__init__() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.__init__",false]],"__init__() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.__init__",false]],"__init__() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.__init__",false]],"__init__() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.__init__",false]],"__init__() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.__init__",false]],"__init__() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.__init__",false]],"__init__() (tdigest_double method)":[[19,"datasketches.tdigest_double.__init__",false]],"__init__() (tdigest_float method)":[[19,"datasketches.tdigest_float.__init__",false]],"__init__() (theta_a_not_b method)":[[3,"datasketches.theta_a_not_b.__init__",false]],"__init__() (theta_intersection method)":[[3,"datasketches.theta_intersection.__init__",false]],"__init__() (theta_union method)":[[3,"datasketches.theta_union.__init__",false]],"__init__() (tuple_a_not_b method)":[[4,"datasketches.tuple_a_not_b.__init__",false]],"__init__() (tuple_intersection method)":[[4,"datasketches.tuple_intersection.__init__",false]],"__init__() (tuple_union method)":[[4,"datasketches.tuple_union.__init__",false]],"__init__() (update_theta_sketch method)":[[3,"datasketches.update_theta_sketch.__init__",false]],"__init__() (update_tuple_sketch method)":[[4,"datasketches.update_tuple_sketch.__init__",false]],"__init__() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.__init__",false]],"__init__() (var_opt_union method)":[[22,"datasketches.var_opt_union.__init__",false]],"accumulatorpolicy (class in datasketches)":[[13,"datasketches.AccumulatorPolicy",false]],"c (ebpps_sketch property)":[[20,"datasketches.ebpps_sketch.c",false]],"compact() (update_theta_sketch method)":[[3,"datasketches.update_theta_sketch.compact",false]],"compact() (update_tuple_sketch method)":[[4,"datasketches.update_tuple_sketch.compact",false]],"compact_theta_sketch (class in datasketches)":[[3,"datasketches.compact_theta_sketch",false]],"compact_tuple_sketch (class in datasketches)":[[4,"datasketches.compact_tuple_sketch",false]],"compress() (tdigest_double method)":[[19,"datasketches.tdigest_double.compress",false]],"compress() (tdigest_float method)":[[19,"datasketches.tdigest_float.compress",false]],"compute() (theta_a_not_b method)":[[3,"datasketches.theta_a_not_b.compute",false]],"compute() (tuple_a_not_b method)":[[4,"datasketches.tuple_a_not_b.compute",false]],"count_min_sketch (class in _datasketches)":[[5,"datasketches.count_min_sketch",false]],"cpc_sketch (class in _datasketches)":[[0,"datasketches.cpc_sketch",false]],"cpc_union (class in _datasketches)":[[0,"datasketches.cpc_union",false]],"create_summary() (tuplepolicy method)":[[13,"datasketches.TuplePolicy.create_summary",false]],"default_seed (tuple_sketch attribute)":[[4,"datasketches.tuple_sketch.DEFAULT_SEED",false]],"density_sketch (class in datasketches)":[[23,"datasketches.density_sketch",false]],"deserialize() (compact_theta_sketch method)":[[3,"datasketches.compact_theta_sketch.deserialize",false]],"deserialize() (compact_tuple_sketch method)":[[4,"datasketches.compact_tuple_sketch.deserialize",false]],"deserialize() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.deserialize",false]],"deserialize() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.deserialize",false]],"deserialize() (density_sketch method)":[[23,"datasketches.density_sketch.deserialize",false]],"deserialize() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.deserialize",false]],"deserialize() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.deserialize",false]],"deserialize() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.deserialize",false]],"deserialize() (hll_sketch method)":[[1,"datasketches.hll_sketch.deserialize",false]],"deserialize() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.deserialize",false]],"deserialize() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.deserialize",false]],"deserialize() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.deserialize",false]],"deserialize() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.deserialize",false]],"deserialize() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.deserialize",false]],"deserialize() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.deserialize",false]],"deserialize() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.deserialize",false]],"deserialize() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.deserialize",false]],"deserialize() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.deserialize",false]],"deserialize() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.deserialize",false]],"deserialize() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.deserialize",false]],"deserialize() (tdigest_double method)":[[19,"datasketches.tdigest_double.deserialize",false]],"deserialize() (tdigest_float method)":[[19,"datasketches.tdigest_float.deserialize",false]],"deserialize() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.deserialize",false]],"deserialize() (var_opt_union method)":[[22,"datasketches.var_opt_union.deserialize",false]],"dim (density_sketch property)":[[23,"datasketches.density_sketch.dim",false]],"dissimilarity_test() (theta_jaccard_similarity method)":[[9,"datasketches.theta_jaccard_similarity.dissimilarity_test",false]],"dissimilarity_test() (tuple_jaccard_similarity method)":[[9,"datasketches.tuple_jaccard_similarity.dissimilarity_test",false]],"ebpps_sketch (class in datasketches)":[[20,"datasketches.ebpps_sketch",false]],"epsilon (frequent_items_sketch property)":[[6,"datasketches.frequent_items_sketch.epsilon",false]],"epsilon (frequent_strings_sketch property)":[[6,"datasketches.frequent_strings_sketch.epsilon",false]],"estimate_subset_sum() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.estimate_subset_sum",false]],"exactly_equal() (theta_jaccard_similarity method)":[[9,"datasketches.theta_jaccard_similarity.exactly_equal",false]],"exactly_equal() (tuple_jaccard_similarity method)":[[9,"datasketches.tuple_jaccard_similarity.exactly_equal",false]],"filter() (compact_tuple_sketch method)":[[4,"datasketches.compact_tuple_sketch.filter",false]],"filter() (update_tuple_sketch method)":[[4,"datasketches.update_tuple_sketch.filter",false]],"frequent_items_error_type (class in datasketches)":[[6,"datasketches.frequent_items_error_type",false]],"frequent_items_sketch (class in datasketches)":[[6,"datasketches.frequent_items_sketch",false]],"frequent_strings_sketch (class in datasketches)":[[6,"datasketches.frequent_strings_sketch",false]],"from_bytes() (pyobjectserde method)":[[12,"datasketches.PyObjectSerDe.from_bytes",false]],"gaussiankernel (class in datasketches)":[[10,"datasketches.GaussianKernel",false]],"get_apriori_error() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.get_apriori_error",false]],"get_apriori_error() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.get_apriori_error",false]],"get_cdf() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.get_cdf",false]],"get_cdf() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.get_cdf",false]],"get_cdf() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.get_cdf",false]],"get_cdf() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.get_cdf",false]],"get_cdf() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.get_cdf",false]],"get_cdf() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.get_cdf",false]],"get_cdf() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.get_cdf",false]],"get_cdf() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.get_cdf",false]],"get_cdf() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_cdf",false]],"get_cdf() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_cdf",false]],"get_cdf() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_cdf",false]],"get_cdf() (tdigest_double method)":[[19,"datasketches.tdigest_double.get_cdf",false]],"get_cdf() (tdigest_float method)":[[19,"datasketches.tdigest_float.get_cdf",false]],"get_compact_serialization_bytes() (hll_sketch method)":[[1,"datasketches.hll_sketch.get_compact_serialization_bytes",false]],"get_epsilon_for_lg_size() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.get_epsilon_for_lg_size",false]],"get_epsilon_for_lg_size() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.get_epsilon_for_lg_size",false]],"get_estimate() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.get_estimate",false]],"get_estimate() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.get_estimate",false]],"get_estimate() (density_sketch method)":[[23,"datasketches.density_sketch.get_estimate",false]],"get_estimate() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.get_estimate",false]],"get_estimate() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.get_estimate",false]],"get_estimate() (hll_sketch method)":[[1,"datasketches.hll_sketch.get_estimate",false]],"get_estimate() (hll_union method)":[[1,"datasketches.hll_union.get_estimate",false]],"get_estimate() (theta_sketch method)":[[3,"datasketches.theta_sketch.get_estimate",false]],"get_estimate() (tuple_sketch method)":[[4,"datasketches.tuple_sketch.get_estimate",false]],"get_frequent_items() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.get_frequent_items",false]],"get_frequent_items() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.get_frequent_items",false]],"get_lower_bound() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.get_lower_bound",false]],"get_lower_bound() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.get_lower_bound",false]],"get_lower_bound() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.get_lower_bound",false]],"get_lower_bound() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.get_lower_bound",false]],"get_lower_bound() (hll_sketch method)":[[1,"datasketches.hll_sketch.get_lower_bound",false]],"get_lower_bound() (hll_union method)":[[1,"datasketches.hll_union.get_lower_bound",false]],"get_lower_bound() (theta_sketch method)":[[3,"datasketches.theta_sketch.get_lower_bound",false]],"get_lower_bound() (tuple_sketch method)":[[4,"datasketches.tuple_sketch.get_lower_bound",false]],"get_max_updatable_serialization_bytes() (hll_sketch method)":[[1,"datasketches.hll_sketch.get_max_updatable_serialization_bytes",false]],"get_max_value() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.get_max_value",false]],"get_max_value() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.get_max_value",false]],"get_max_value() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.get_max_value",false]],"get_max_value() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.get_max_value",false]],"get_max_value() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.get_max_value",false]],"get_max_value() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.get_max_value",false]],"get_max_value() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.get_max_value",false]],"get_max_value() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.get_max_value",false]],"get_max_value() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_max_value",false]],"get_max_value() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_max_value",false]],"get_max_value() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_max_value",false]],"get_max_value() (tdigest_double method)":[[19,"datasketches.tdigest_double.get_max_value",false]],"get_max_value() (tdigest_float method)":[[19,"datasketches.tdigest_float.get_max_value",false]],"get_min_value() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.get_min_value",false]],"get_min_value() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.get_min_value",false]],"get_min_value() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.get_min_value",false]],"get_min_value() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.get_min_value",false]],"get_min_value() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.get_min_value",false]],"get_min_value() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.get_min_value",false]],"get_min_value() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.get_min_value",false]],"get_min_value() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.get_min_value",false]],"get_min_value() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_min_value",false]],"get_min_value() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_min_value",false]],"get_min_value() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_min_value",false]],"get_min_value() (tdigest_double method)":[[19,"datasketches.tdigest_double.get_min_value",false]],"get_min_value() (tdigest_float method)":[[19,"datasketches.tdigest_float.get_min_value",false]],"get_normalized_rank_error() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.get_normalized_rank_error",false]],"get_normalized_rank_error() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.get_normalized_rank_error",false]],"get_pmf() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.get_pmf",false]],"get_pmf() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.get_pmf",false]],"get_pmf() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.get_pmf",false]],"get_pmf() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.get_pmf",false]],"get_pmf() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.get_pmf",false]],"get_pmf() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.get_pmf",false]],"get_pmf() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.get_pmf",false]],"get_pmf() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.get_pmf",false]],"get_pmf() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_pmf",false]],"get_pmf() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_pmf",false]],"get_pmf() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_pmf",false]],"get_pmf() (tdigest_double method)":[[19,"datasketches.tdigest_double.get_pmf",false]],"get_pmf() (tdigest_float method)":[[19,"datasketches.tdigest_float.get_pmf",false]],"get_quantile() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.get_quantile",false]],"get_quantile() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.get_quantile",false]],"get_quantile() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.get_quantile",false]],"get_quantile() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.get_quantile",false]],"get_quantile() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.get_quantile",false]],"get_quantile() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.get_quantile",false]],"get_quantile() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.get_quantile",false]],"get_quantile() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.get_quantile",false]],"get_quantile() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_quantile",false]],"get_quantile() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_quantile",false]],"get_quantile() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_quantile",false]],"get_quantile() (tdigest_double method)":[[19,"datasketches.tdigest_double.get_quantile",false]],"get_quantile() (tdigest_float method)":[[19,"datasketches.tdigest_float.get_quantile",false]],"get_quantiles() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.get_quantiles",false]],"get_quantiles() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.get_quantiles",false]],"get_quantiles() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.get_quantiles",false]],"get_quantiles() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.get_quantiles",false]],"get_quantiles() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.get_quantiles",false]],"get_quantiles() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.get_quantiles",false]],"get_quantiles() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.get_quantiles",false]],"get_quantiles() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.get_quantiles",false]],"get_quantiles() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_quantiles",false]],"get_quantiles() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_quantiles",false]],"get_quantiles() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_quantiles",false]],"get_rank() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.get_rank",false]],"get_rank() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.get_rank",false]],"get_rank() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.get_rank",false]],"get_rank() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.get_rank",false]],"get_rank() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.get_rank",false]],"get_rank() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.get_rank",false]],"get_rank() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.get_rank",false]],"get_rank() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.get_rank",false]],"get_rank() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_rank",false]],"get_rank() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_rank",false]],"get_rank() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_rank",false]],"get_rank() (tdigest_double method)":[[19,"datasketches.tdigest_double.get_rank",false]],"get_rank() (tdigest_float method)":[[19,"datasketches.tdigest_float.get_rank",false]],"get_rank_lower_bound() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_rank_lower_bound",false]],"get_rank_lower_bound() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_rank_lower_bound",false]],"get_rank_lower_bound() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_rank_lower_bound",false]],"get_rank_upper_bound() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_rank_upper_bound",false]],"get_rank_upper_bound() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_rank_upper_bound",false]],"get_rank_upper_bound() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_rank_upper_bound",false]],"get_rel_err() (hll_sketch method)":[[1,"datasketches.hll_sketch.get_rel_err",false]],"get_rel_err() (hll_union method)":[[1,"datasketches.hll_union.get_rel_err",false]],"get_relative_error() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.get_relative_error",false]],"get_result() (cpc_union method)":[[0,"datasketches.cpc_union.get_result",false]],"get_result() (hll_union method)":[[1,"datasketches.hll_union.get_result",false]],"get_result() (theta_intersection method)":[[3,"datasketches.theta_intersection.get_result",false]],"get_result() (theta_union method)":[[3,"datasketches.theta_union.get_result",false]],"get_result() (tuple_intersection method)":[[4,"datasketches.tuple_intersection.get_result",false]],"get_result() (tuple_union method)":[[4,"datasketches.tuple_union.get_result",false]],"get_result() (var_opt_union method)":[[22,"datasketches.var_opt_union.get_result",false]],"get_rse() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.get_RSE",false]],"get_rse() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.get_RSE",false]],"get_rse() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.get_RSE",false]],"get_seed_hash() (theta_sketch method)":[[3,"datasketches.theta_sketch.get_seed_hash",false]],"get_seed_hash() (tuple_sketch method)":[[4,"datasketches.tuple_sketch.get_seed_hash",false]],"get_serialized_size_bytes() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes() (tdigest_double method)":[[19,"datasketches.tdigest_double.get_serialized_size_bytes",false]],"get_serialized_size_bytes() (tdigest_float method)":[[19,"datasketches.tdigest_float.get_serialized_size_bytes",false]],"get_serialized_size_bytes() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.get_serialized_size_bytes",false]],"get_serialized_size_bytes() (var_opt_union method)":[[22,"datasketches.var_opt_union.get_serialized_size_bytes",false]],"get_size() (pyobjectserde method)":[[12,"datasketches.PyObjectSerDe.get_size",false]],"get_total_weight() (tdigest_double method)":[[19,"datasketches.tdigest_double.get_total_weight",false]],"get_total_weight() (tdigest_float method)":[[19,"datasketches.tdigest_float.get_total_weight",false]],"get_updatable_serialization_bytes() (hll_sketch method)":[[1,"datasketches.hll_sketch.get_updatable_serialization_bytes",false]],"get_upper_bound() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.get_upper_bound",false]],"get_upper_bound() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.get_upper_bound",false]],"get_upper_bound() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.get_upper_bound",false]],"get_upper_bound() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.get_upper_bound",false]],"get_upper_bound() (hll_sketch method)":[[1,"datasketches.hll_sketch.get_upper_bound",false]],"get_upper_bound() (hll_union method)":[[1,"datasketches.hll_union.get_upper_bound",false]],"get_upper_bound() (theta_sketch method)":[[3,"datasketches.theta_sketch.get_upper_bound",false]],"get_upper_bound() (tuple_sketch method)":[[4,"datasketches.tuple_sketch.get_upper_bound",false]],"has_result() (theta_intersection method)":[[3,"datasketches.theta_intersection.has_result",false]],"has_result() (tuple_intersection method)":[[4,"datasketches.tuple_intersection.has_result",false]],"hll_4 (tgt_hll_type attribute)":[[1,"datasketches.tgt_hll_type.HLL_4",false]],"hll_6 (tgt_hll_type attribute)":[[1,"datasketches.tgt_hll_type.HLL_6",false]],"hll_8 (tgt_hll_type attribute)":[[1,"datasketches.tgt_hll_type.HLL_8",false]],"hll_sketch (class in _datasketches)":[[1,"datasketches.hll_sketch",false]],"hll_union (class in _datasketches)":[[1,"datasketches.hll_union",false]],"is_compact() (hll_sketch method)":[[1,"datasketches.hll_sketch.is_compact",false]],"is_empty() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.is_empty",false]],"is_empty() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.is_empty",false]],"is_empty() (density_sketch method)":[[23,"datasketches.density_sketch.is_empty",false]],"is_empty() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.is_empty",false]],"is_empty() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.is_empty",false]],"is_empty() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.is_empty",false]],"is_empty() (hll_sketch method)":[[1,"datasketches.hll_sketch.is_empty",false]],"is_empty() (hll_union method)":[[1,"datasketches.hll_union.is_empty",false]],"is_empty() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.is_empty",false]],"is_empty() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.is_empty",false]],"is_empty() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.is_empty",false]],"is_empty() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.is_empty",false]],"is_empty() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.is_empty",false]],"is_empty() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.is_empty",false]],"is_empty() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.is_empty",false]],"is_empty() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.is_empty",false]],"is_empty() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.is_empty",false]],"is_empty() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.is_empty",false]],"is_empty() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.is_empty",false]],"is_empty() (tdigest_double method)":[[19,"datasketches.tdigest_double.is_empty",false]],"is_empty() (tdigest_float method)":[[19,"datasketches.tdigest_float.is_empty",false]],"is_empty() (theta_sketch method)":[[3,"datasketches.theta_sketch.is_empty",false]],"is_empty() (tuple_sketch method)":[[4,"datasketches.tuple_sketch.is_empty",false]],"is_empty() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.is_empty",false]],"is_estimation_mode() (density_sketch method)":[[23,"datasketches.density_sketch.is_estimation_mode",false]],"is_estimation_mode() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.is_estimation_mode",false]],"is_estimation_mode() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.is_estimation_mode",false]],"is_estimation_mode() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.is_estimation_mode",false]],"is_estimation_mode() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.is_estimation_mode",false]],"is_estimation_mode() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.is_estimation_mode",false]],"is_estimation_mode() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.is_estimation_mode",false]],"is_estimation_mode() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.is_estimation_mode",false]],"is_estimation_mode() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.is_estimation_mode",false]],"is_estimation_mode() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.is_estimation_mode",false]],"is_estimation_mode() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.is_estimation_mode",false]],"is_estimation_mode() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.is_estimation_mode",false]],"is_estimation_mode() (theta_sketch method)":[[3,"datasketches.theta_sketch.is_estimation_mode",false]],"is_estimation_mode() (tuple_sketch method)":[[4,"datasketches.tuple_sketch.is_estimation_mode",false]],"is_hra() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.is_hra",false]],"is_hra() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.is_hra",false]],"is_hra() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.is_hra",false]],"is_ordered() (theta_sketch method)":[[3,"datasketches.theta_sketch.is_ordered",false]],"is_ordered() (tuple_sketch method)":[[4,"datasketches.tuple_sketch.is_ordered",false]],"jaccard() (theta_jaccard_similarity method)":[[9,"datasketches.theta_jaccard_similarity.jaccard",false]],"jaccard() (tuple_jaccard_similarity method)":[[9,"datasketches.tuple_jaccard_similarity.jaccard",false]],"k (density_sketch property)":[[23,"datasketches.density_sketch.k",false]],"k (ebpps_sketch property)":[[20,"datasketches.ebpps_sketch.k",false]],"k (kll_doubles_sketch property)":[[16,"datasketches.kll_doubles_sketch.k",false]],"k (kll_floats_sketch property)":[[16,"datasketches.kll_floats_sketch.k",false]],"k (kll_ints_sketch property)":[[16,"datasketches.kll_ints_sketch.k",false]],"k (kll_items_sketch property)":[[16,"datasketches.kll_items_sketch.k",false]],"k (quantiles_doubles_sketch property)":[[17,"datasketches.quantiles_doubles_sketch.k",false]],"k (quantiles_floats_sketch property)":[[17,"datasketches.quantiles_floats_sketch.k",false]],"k (quantiles_ints_sketch property)":[[17,"datasketches.quantiles_ints_sketch.k",false]],"k (quantiles_items_sketch property)":[[17,"datasketches.quantiles_items_sketch.k",false]],"k (req_floats_sketch property)":[[18,"datasketches.req_floats_sketch.k",false]],"k (req_ints_sketch property)":[[18,"datasketches.req_ints_sketch.k",false]],"k (req_items_sketch property)":[[18,"datasketches.req_items_sketch.k",false]],"k (tdigest_double property)":[[19,"datasketches.tdigest_double.k",false]],"k (tdigest_float property)":[[19,"datasketches.tdigest_float.k",false]],"k (var_opt_sketch property)":[[22,"datasketches.var_opt_sketch.k",false]],"kernelfunction (class in datasketches)":[[10,"datasketches.KernelFunction",false]],"kll_doubles_sketch (class in datasketches)":[[16,"datasketches.kll_doubles_sketch",false]],"kll_floats_sketch (class in datasketches)":[[16,"datasketches.kll_floats_sketch",false]],"kll_ints_sketch (class in datasketches)":[[16,"datasketches.kll_ints_sketch",false]],"kll_items_sketch (class in datasketches)":[[16,"datasketches.kll_items_sketch",false]],"ks_test() (in module datasketches)":[[11,"datasketches.ks_test",false]],"lg_config_k (hll_sketch property)":[[1,"datasketches.hll_sketch.lg_config_k",false]],"lg_config_k (hll_union property)":[[1,"datasketches.hll_union.lg_config_k",false]],"lg_k (cpc_sketch property)":[[0,"datasketches.cpc_sketch.lg_k",false]],"maxintpolicy (class in datasketches)":[[13,"datasketches.MaxIntPolicy",false]],"merge() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.merge",false]],"merge() (density_sketch method)":[[23,"datasketches.density_sketch.merge",false]],"merge() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.merge",false]],"merge() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.merge",false]],"merge() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.merge",false]],"merge() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.merge",false]],"merge() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.merge",false]],"merge() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.merge",false]],"merge() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.merge",false]],"merge() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.merge",false]],"merge() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.merge",false]],"merge() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.merge",false]],"merge() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.merge",false]],"merge() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.merge",false]],"merge() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.merge",false]],"merge() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.merge",false]],"merge() (tdigest_double method)":[[19,"datasketches.tdigest_double.merge",false]],"merge() (tdigest_float method)":[[19,"datasketches.tdigest_float.merge",false]],"minintpolicy (class in datasketches)":[[13,"datasketches.MinIntPolicy",false]],"n (density_sketch property)":[[23,"datasketches.density_sketch.n",false]],"n (ebpps_sketch property)":[[20,"datasketches.ebpps_sketch.n",false]],"n (kll_doubles_sketch property)":[[16,"datasketches.kll_doubles_sketch.n",false]],"n (kll_floats_sketch property)":[[16,"datasketches.kll_floats_sketch.n",false]],"n (kll_ints_sketch property)":[[16,"datasketches.kll_ints_sketch.n",false]],"n (kll_items_sketch property)":[[16,"datasketches.kll_items_sketch.n",false]],"n (quantiles_doubles_sketch property)":[[17,"datasketches.quantiles_doubles_sketch.n",false]],"n (quantiles_floats_sketch property)":[[17,"datasketches.quantiles_floats_sketch.n",false]],"n (quantiles_ints_sketch property)":[[17,"datasketches.quantiles_ints_sketch.n",false]],"n (quantiles_items_sketch property)":[[17,"datasketches.quantiles_items_sketch.n",false]],"n (req_floats_sketch property)":[[18,"datasketches.req_floats_sketch.n",false]],"n (req_ints_sketch property)":[[18,"datasketches.req_ints_sketch.n",false]],"n (req_items_sketch property)":[[18,"datasketches.req_items_sketch.n",false]],"n (var_opt_sketch property)":[[22,"datasketches.var_opt_sketch.n",false]],"no_false_negatives (frequent_items_error_type attribute)":[[6,"datasketches.frequent_items_error_type.NO_FALSE_NEGATIVES",false]],"no_false_positives (frequent_items_error_type attribute)":[[6,"datasketches.frequent_items_error_type.NO_FALSE_POSITIVES",false]],"normalized_rank_error() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.normalized_rank_error",false]],"normalized_rank_error() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.normalized_rank_error",false]],"normalized_rank_error() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.normalized_rank_error",false]],"normalized_rank_error() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.normalized_rank_error",false]],"normalized_rank_error() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.normalized_rank_error",false]],"normalized_rank_error() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.normalized_rank_error",false]],"normalized_rank_error() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.normalized_rank_error",false]],"normalized_rank_error() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.normalized_rank_error",false]],"num_active_items (frequent_items_sketch property)":[[6,"datasketches.frequent_items_sketch.num_active_items",false]],"num_active_items (frequent_strings_sketch property)":[[6,"datasketches.frequent_strings_sketch.num_active_items",false]],"num_buckets (count_min_sketch property)":[[5,"datasketches.count_min_sketch.num_buckets",false]],"num_hashes (count_min_sketch property)":[[5,"datasketches.count_min_sketch.num_hashes",false]],"num_retained (density_sketch property)":[[23,"datasketches.density_sketch.num_retained",false]],"num_retained (kll_doubles_sketch property)":[[16,"datasketches.kll_doubles_sketch.num_retained",false]],"num_retained (kll_floats_sketch property)":[[16,"datasketches.kll_floats_sketch.num_retained",false]],"num_retained (kll_ints_sketch property)":[[16,"datasketches.kll_ints_sketch.num_retained",false]],"num_retained (kll_items_sketch property)":[[16,"datasketches.kll_items_sketch.num_retained",false]],"num_retained (quantiles_doubles_sketch property)":[[17,"datasketches.quantiles_doubles_sketch.num_retained",false]],"num_retained (quantiles_floats_sketch property)":[[17,"datasketches.quantiles_floats_sketch.num_retained",false]],"num_retained (quantiles_ints_sketch property)":[[17,"datasketches.quantiles_ints_sketch.num_retained",false]],"num_retained (quantiles_items_sketch property)":[[17,"datasketches.quantiles_items_sketch.num_retained",false]],"num_retained (req_floats_sketch property)":[[18,"datasketches.req_floats_sketch.num_retained",false]],"num_retained (req_ints_sketch property)":[[18,"datasketches.req_ints_sketch.num_retained",false]],"num_retained (req_items_sketch property)":[[18,"datasketches.req_items_sketch.num_retained",false]],"num_retained (theta_sketch property)":[[3,"datasketches.theta_sketch.num_retained",false]],"num_retained (tuple_sketch property)":[[4,"datasketches.tuple_sketch.num_retained",false]],"num_samples (var_opt_sketch property)":[[22,"datasketches.var_opt_sketch.num_samples",false]],"pydoublesserde (class in datasketches)":[[12,"datasketches.PyDoublesSerDe",false]],"pyfloatsserde (class in datasketches)":[[12,"datasketches.PyFloatsSerDe",false]],"pyintsserde (class in datasketches)":[[12,"datasketches.PyIntsSerDe",false]],"pylongsserde (class in datasketches)":[[12,"datasketches.PyLongsSerDe",false]],"pyobjectserde (class in datasketches)":[[12,"datasketches.PyObjectSerDe",false]],"pystringsserde (class in datasketches)":[[12,"datasketches.PyStringsSerDe",false]],"quantiles_doubles_sketch (class in datasketches)":[[17,"datasketches.quantiles_doubles_sketch",false]],"quantiles_floats_sketch (class in datasketches)":[[17,"datasketches.quantiles_floats_sketch",false]],"quantiles_ints_sketch (class in datasketches)":[[17,"datasketches.quantiles_ints_sketch",false]],"quantiles_items_sketch (class in datasketches)":[[17,"datasketches.quantiles_items_sketch",false]],"req_floats_sketch (class in datasketches)":[[18,"datasketches.req_floats_sketch",false]],"req_ints_sketch (class in datasketches)":[[18,"datasketches.req_ints_sketch",false]],"req_items_sketch (class in datasketches)":[[18,"datasketches.req_items_sketch",false]],"reset() (hll_sketch method)":[[1,"datasketches.hll_sketch.reset",false]],"reset() (hll_union method)":[[1,"datasketches.hll_union.reset",false]],"reset() (tuple_union method)":[[4,"datasketches.tuple_union.reset",false]],"reset() (update_theta_sketch method)":[[3,"datasketches.update_theta_sketch.reset",false]],"reset() (update_tuple_sketch method)":[[4,"datasketches.update_tuple_sketch.reset",false]],"reset() (var_opt_union method)":[[22,"datasketches.var_opt_union.reset",false]],"seed (count_min_sketch property)":[[5,"datasketches.count_min_sketch.seed",false]],"serialize() (compact_theta_sketch method)":[[3,"datasketches.compact_theta_sketch.serialize",false]],"serialize() (compact_tuple_sketch method)":[[4,"datasketches.compact_tuple_sketch.serialize",false]],"serialize() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.serialize",false]],"serialize() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.serialize",false]],"serialize() (density_sketch method)":[[23,"datasketches.density_sketch.serialize",false]],"serialize() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.serialize",false]],"serialize() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.serialize",false]],"serialize() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.serialize",false]],"serialize() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.serialize",false]],"serialize() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.serialize",false]],"serialize() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.serialize",false]],"serialize() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.serialize",false]],"serialize() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.serialize",false]],"serialize() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.serialize",false]],"serialize() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.serialize",false]],"serialize() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.serialize",false]],"serialize() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.serialize",false]],"serialize() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.serialize",false]],"serialize() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.serialize",false]],"serialize() (tdigest_double method)":[[19,"datasketches.tdigest_double.serialize",false]],"serialize() (tdigest_float method)":[[19,"datasketches.tdigest_float.serialize",false]],"serialize() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.serialize",false]],"serialize() (var_opt_union method)":[[22,"datasketches.var_opt_union.serialize",false]],"serialize_compact() (hll_sketch method)":[[1,"datasketches.hll_sketch.serialize_compact",false]],"serialize_updatable() (hll_sketch method)":[[1,"datasketches.hll_sketch.serialize_updatable",false]],"similarity_test() (theta_jaccard_similarity method)":[[9,"datasketches.theta_jaccard_similarity.similarity_test",false]],"similarity_test() (tuple_jaccard_similarity method)":[[9,"datasketches.tuple_jaccard_similarity.similarity_test",false]],"suggest_num_buckets() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.suggest_num_buckets",false]],"suggest_num_hashes() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.suggest_num_hashes",false]],"tdigest_double (class in datasketches)":[[19,"datasketches.tdigest_double",false]],"tdigest_float (class in datasketches)":[[19,"datasketches.tdigest_float",false]],"tgt_hll_type (class in _datasketches)":[[1,"datasketches.tgt_hll_type",false]],"tgt_type (hll_sketch property)":[[1,"datasketches.hll_sketch.tgt_type",false]],"theta (theta_sketch property)":[[3,"datasketches.theta_sketch.theta",false]],"theta (tuple_sketch property)":[[4,"datasketches.tuple_sketch.theta",false]],"theta64 (theta_sketch property)":[[3,"datasketches.theta_sketch.theta64",false]],"theta64 (tuple_sketch property)":[[4,"datasketches.tuple_sketch.theta64",false]],"theta_a_not_b (class in datasketches)":[[3,"datasketches.theta_a_not_b",false]],"theta_intersection (class in datasketches)":[[3,"datasketches.theta_intersection",false]],"theta_jaccard_similarity (class in datasketches)":[[9,"datasketches.theta_jaccard_similarity",false]],"theta_sketch (class in datasketches)":[[3,"datasketches.theta_sketch",false]],"theta_union (class in datasketches)":[[3,"datasketches.theta_union",false]],"to_bytes() (pyobjectserde method)":[[12,"datasketches.PyObjectSerDe.to_bytes",false]],"to_string() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.to_string",false]],"to_string() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.to_string",false]],"to_string() (density_sketch method)":[[23,"datasketches.density_sketch.to_string",false]],"to_string() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.to_string",false]],"to_string() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.to_string",false]],"to_string() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.to_string",false]],"to_string() (hll_sketch method)":[[1,"datasketches.hll_sketch.to_string",false]],"to_string() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.to_string",false]],"to_string() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.to_string",false]],"to_string() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.to_string",false]],"to_string() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.to_string",false]],"to_string() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.to_string",false]],"to_string() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.to_string",false]],"to_string() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.to_string",false]],"to_string() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.to_string",false]],"to_string() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.to_string",false]],"to_string() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.to_string",false]],"to_string() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.to_string",false]],"to_string() (tdigest_double method)":[[19,"datasketches.tdigest_double.to_string",false]],"to_string() (tdigest_float method)":[[19,"datasketches.tdigest_float.to_string",false]],"to_string() (theta_sketch method)":[[3,"datasketches.theta_sketch.to_string",false]],"to_string() (tuple_sketch method)":[[4,"datasketches.tuple_sketch.to_string",false]],"to_string() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.to_string",false]],"to_string() (var_opt_union method)":[[22,"datasketches.var_opt_union.to_string",false]],"total_weight (count_min_sketch property)":[[5,"datasketches.count_min_sketch.total_weight",false]],"total_weight (frequent_items_sketch property)":[[6,"datasketches.frequent_items_sketch.total_weight",false]],"total_weight (frequent_strings_sketch property)":[[6,"datasketches.frequent_strings_sketch.total_weight",false]],"trim() (update_theta_sketch method)":[[3,"datasketches.update_theta_sketch.trim",false]],"trim() (update_tuple_sketch method)":[[4,"datasketches.update_tuple_sketch.trim",false]],"tuple_a_not_b (class in datasketches)":[[4,"datasketches.tuple_a_not_b",false]],"tuple_intersection (class in datasketches)":[[4,"datasketches.tuple_intersection",false]],"tuple_jaccard_similarity (class in datasketches)":[[9,"datasketches.tuple_jaccard_similarity",false]],"tuple_sketch (class in datasketches)":[[4,"datasketches.tuple_sketch",false]],"tuple_union (class in datasketches)":[[4,"datasketches.tuple_union",false]],"tuplepolicy (class in datasketches)":[[13,"datasketches.TuplePolicy",false]],"update() (count_min_sketch method)":[[5,"datasketches.count_min_sketch.update",false]],"update() (cpc_sketch method)":[[0,"datasketches.cpc_sketch.update",false]],"update() (cpc_union method)":[[0,"datasketches.cpc_union.update",false]],"update() (density_sketch method)":[[23,"datasketches.density_sketch.update",false]],"update() (ebpps_sketch method)":[[20,"datasketches.ebpps_sketch.update",false]],"update() (frequent_items_sketch method)":[[6,"datasketches.frequent_items_sketch.update",false]],"update() (frequent_strings_sketch method)":[[6,"datasketches.frequent_strings_sketch.update",false]],"update() (hll_sketch method)":[[1,"datasketches.hll_sketch.update",false]],"update() (hll_union method)":[[1,"datasketches.hll_union.update",false]],"update() (kll_doubles_sketch method)":[[16,"datasketches.kll_doubles_sketch.update",false]],"update() (kll_floats_sketch method)":[[16,"datasketches.kll_floats_sketch.update",false]],"update() (kll_ints_sketch method)":[[16,"datasketches.kll_ints_sketch.update",false]],"update() (kll_items_sketch method)":[[16,"datasketches.kll_items_sketch.update",false]],"update() (quantiles_doubles_sketch method)":[[17,"datasketches.quantiles_doubles_sketch.update",false]],"update() (quantiles_floats_sketch method)":[[17,"datasketches.quantiles_floats_sketch.update",false]],"update() (quantiles_ints_sketch method)":[[17,"datasketches.quantiles_ints_sketch.update",false]],"update() (quantiles_items_sketch method)":[[17,"datasketches.quantiles_items_sketch.update",false]],"update() (req_floats_sketch method)":[[18,"datasketches.req_floats_sketch.update",false]],"update() (req_ints_sketch method)":[[18,"datasketches.req_ints_sketch.update",false]],"update() (req_items_sketch method)":[[18,"datasketches.req_items_sketch.update",false]],"update() (tdigest_double method)":[[19,"datasketches.tdigest_double.update",false]],"update() (tdigest_float method)":[[19,"datasketches.tdigest_float.update",false]],"update() (theta_intersection method)":[[3,"datasketches.theta_intersection.update",false]],"update() (theta_union method)":[[3,"datasketches.theta_union.update",false]],"update() (tuple_intersection method)":[[4,"datasketches.tuple_intersection.update",false]],"update() (tuple_union method)":[[4,"datasketches.tuple_union.update",false]],"update() (update_theta_sketch method)":[[3,"datasketches.update_theta_sketch.update",false]],"update() (update_tuple_sketch method)":[[4,"datasketches.update_tuple_sketch.update",false]],"update() (var_opt_sketch method)":[[22,"datasketches.var_opt_sketch.update",false]],"update() (var_opt_union method)":[[22,"datasketches.var_opt_union.update",false]],"update_summary() (tuplepolicy method)":[[13,"datasketches.TuplePolicy.update_summary",false]],"update_theta_sketch (class in datasketches)":[[3,"datasketches.update_theta_sketch",false]],"update_tuple_sketch (class in datasketches)":[[4,"datasketches.update_tuple_sketch",false]],"var_opt_sketch (class in datasketches)":[[22,"datasketches.var_opt_sketch",false]],"var_opt_union (class in datasketches)":[[22,"datasketches.var_opt_union",false]]},"objects":{"_datasketches":[[5,0,1,"datasketches.count_min_sketch","count_min_sketch"],[0,0,1,"datasketches.cpc_sketch","cpc_sketch"],[0,0,1,"datasketches.cpc_union","cpc_union"],[1,0,1,"datasketches.hll_sketch","hll_sketch"],[1,0,1,"datasketches.hll_union","hll_union"],[1,0,1,"datasketches.tgt_hll_type","tgt_hll_type"]],"_datasketches.count_min_sketch":[[5,1,1,"datasketches.count_min_sketch.deserialize","deserialize"],[5,1,1,"datasketches.count_min_sketch.get_estimate","get_estimate"],[5,1,1,"datasketches.count_min_sketch.get_lower_bound","get_lower_bound"],[5,1,1,"datasketches.count_min_sketch.get_relative_error","get_relative_error"],[5,1,1,"datasketches.count_min_sketch.get_serialized_size_bytes","get_serialized_size_bytes"],[5,1,1,"datasketches.count_min_sketch.get_upper_bound","get_upper_bound"],[5,1,1,"datasketches.count_min_sketch.is_empty","is_empty"],[5,1,1,"datasketches.count_min_sketch.merge","merge"],[5,2,1,"datasketches.count_min_sketch.num_buckets","num_buckets"],[5,2,1,"datasketches.count_min_sketch.num_hashes","num_hashes"],[5,2,1,"datasketches.count_min_sketch.seed","seed"],[5,1,1,"datasketches.count_min_sketch.serialize","serialize"],[5,1,1,"datasketches.count_min_sketch.suggest_num_buckets","suggest_num_buckets"],[5,1,1,"datasketches.count_min_sketch.suggest_num_hashes","suggest_num_hashes"],[5,1,1,"datasketches.count_min_sketch.to_string","to_string"],[5,2,1,"datasketches.count_min_sketch.total_weight","total_weight"],[5,1,1,"datasketches.count_min_sketch.update","update"]],"_datasketches.cpc_sketch":[[0,1,1,"datasketches.cpc_sketch.__init__","__init__"],[0,1,1,"datasketches.cpc_sketch.deserialize","deserialize"],[0,1,1,"datasketches.cpc_sketch.get_estimate","get_estimate"],[0,1,1,"datasketches.cpc_sketch.get_lower_bound","get_lower_bound"],[0,1,1,"datasketches.cpc_sketch.get_upper_bound","get_upper_bound"],[0,1,1,"datasketches.cpc_sketch.is_empty","is_empty"],[0,2,1,"datasketches.cpc_sketch.lg_k","lg_k"],[0,1,1,"datasketches.cpc_sketch.serialize","serialize"],[0,1,1,"datasketches.cpc_sketch.to_string","to_string"],[0,1,1,"datasketches.cpc_sketch.update","update"]],"_datasketches.cpc_union":[[0,1,1,"datasketches.cpc_union.__init__","__init__"],[0,1,1,"datasketches.cpc_union.get_result","get_result"],[0,1,1,"datasketches.cpc_union.update","update"]],"_datasketches.hll_sketch":[[1,1,1,"datasketches.hll_sketch.__init__","__init__"],[1,1,1,"datasketches.hll_sketch.deserialize","deserialize"],[1,1,1,"datasketches.hll_sketch.get_compact_serialization_bytes","get_compact_serialization_bytes"],[1,1,1,"datasketches.hll_sketch.get_estimate","get_estimate"],[1,1,1,"datasketches.hll_sketch.get_lower_bound","get_lower_bound"],[1,1,1,"datasketches.hll_sketch.get_max_updatable_serialization_bytes","get_max_updatable_serialization_bytes"],[1,1,1,"datasketches.hll_sketch.get_rel_err","get_rel_err"],[1,1,1,"datasketches.hll_sketch.get_updatable_serialization_bytes","get_updatable_serialization_bytes"],[1,1,1,"datasketches.hll_sketch.get_upper_bound","get_upper_bound"],[1,1,1,"datasketches.hll_sketch.is_compact","is_compact"],[1,1,1,"datasketches.hll_sketch.is_empty","is_empty"],[1,2,1,"datasketches.hll_sketch.lg_config_k","lg_config_k"],[1,1,1,"datasketches.hll_sketch.reset","reset"],[1,1,1,"datasketches.hll_sketch.serialize_compact","serialize_compact"],[1,1,1,"datasketches.hll_sketch.serialize_updatable","serialize_updatable"],[1,2,1,"datasketches.hll_sketch.tgt_type","tgt_type"],[1,1,1,"datasketches.hll_sketch.to_string","to_string"],[1,1,1,"datasketches.hll_sketch.update","update"]],"_datasketches.hll_union":[[1,1,1,"datasketches.hll_union.__init__","__init__"],[1,1,1,"datasketches.hll_union.get_estimate","get_estimate"],[1,1,1,"datasketches.hll_union.get_lower_bound","get_lower_bound"],[1,1,1,"datasketches.hll_union.get_rel_err","get_rel_err"],[1,1,1,"datasketches.hll_union.get_result","get_result"],[1,1,1,"datasketches.hll_union.get_upper_bound","get_upper_bound"],[1,1,1,"datasketches.hll_union.is_empty","is_empty"],[1,2,1,"datasketches.hll_union.lg_config_k","lg_config_k"],[1,1,1,"datasketches.hll_union.reset","reset"],[1,1,1,"datasketches.hll_union.update","update"]],"_datasketches.tgt_hll_type":[[1,3,1,"datasketches.tgt_hll_type.HLL_4","HLL_4"],[1,3,1,"datasketches.tgt_hll_type.HLL_6","HLL_6"],[1,3,1,"datasketches.tgt_hll_type.HLL_8","HLL_8"]],"datasketches":[[13,0,1,"","AccumulatorPolicy"],[10,0,1,"","GaussianKernel"],[10,0,1,"","KernelFunction"],[13,0,1,"","MaxIntPolicy"],[13,0,1,"","MinIntPolicy"],[12,0,1,"","PyDoublesSerDe"],[12,0,1,"","PyFloatsSerDe"],[12,0,1,"","PyIntsSerDe"],[12,0,1,"","PyLongsSerDe"],[12,0,1,"","PyObjectSerDe"],[12,0,1,"","PyStringsSerDe"],[13,0,1,"","TuplePolicy"],[3,0,1,"","compact_theta_sketch"],[4,0,1,"","compact_tuple_sketch"],[23,0,1,"","density_sketch"],[20,0,1,"","ebpps_sketch"],[6,0,1,"","frequent_items_error_type"],[6,0,1,"","frequent_items_sketch"],[6,0,1,"","frequent_strings_sketch"],[16,0,1,"","kll_doubles_sketch"],[16,0,1,"","kll_floats_sketch"],[16,0,1,"","kll_ints_sketch"],[16,0,1,"","kll_items_sketch"],[11,4,1,"","ks_test"],[17,0,1,"","quantiles_doubles_sketch"],[17,0,1,"","quantiles_floats_sketch"],[17,0,1,"","quantiles_ints_sketch"],[17,0,1,"","quantiles_items_sketch"],[18,0,1,"","req_floats_sketch"],[18,0,1,"","req_ints_sketch"],[18,0,1,"","req_items_sketch"],[19,0,1,"","tdigest_double"],[19,0,1,"","tdigest_float"],[3,0,1,"","theta_a_not_b"],[3,0,1,"","theta_intersection"],[9,0,1,"","theta_jaccard_similarity"],[3,0,1,"","theta_sketch"],[3,0,1,"","theta_union"],[4,0,1,"","tuple_a_not_b"],[4,0,1,"","tuple_intersection"],[9,0,1,"","tuple_jaccard_similarity"],[4,0,1,"","tuple_sketch"],[4,0,1,"","tuple_union"],[3,0,1,"","update_theta_sketch"],[4,0,1,"","update_tuple_sketch"],[22,0,1,"","var_opt_sketch"],[22,0,1,"","var_opt_union"]],"datasketches.KernelFunction":[[10,1,1,"","__call__"]],"datasketches.PyObjectSerDe":[[12,1,1,"","from_bytes"],[12,1,1,"","get_size"],[12,1,1,"","to_bytes"]],"datasketches.TuplePolicy":[[13,1,1,"","__call__"],[13,1,1,"","create_summary"],[13,1,1,"","update_summary"]],"datasketches.compact_theta_sketch":[[3,1,1,"","__init__"],[3,1,1,"","deserialize"],[3,1,1,"","serialize"]],"datasketches.compact_tuple_sketch":[[4,1,1,"","__init__"],[4,1,1,"","deserialize"],[4,1,1,"","filter"],[4,1,1,"","serialize"]],"datasketches.density_sketch":[[23,1,1,"","__init__"],[23,1,1,"","deserialize"],[23,2,1,"","dim"],[23,1,1,"","get_estimate"],[23,1,1,"","is_empty"],[23,1,1,"","is_estimation_mode"],[23,2,1,"","k"],[23,1,1,"","merge"],[23,2,1,"","n"],[23,2,1,"","num_retained"],[23,1,1,"","serialize"],[23,1,1,"","to_string"],[23,1,1,"","update"]],"datasketches.ebpps_sketch":[[20,1,1,"","__init__"],[20,2,1,"","c"],[20,1,1,"","deserialize"],[20,1,1,"","get_serialized_size_bytes"],[20,1,1,"","is_empty"],[20,2,1,"","k"],[20,1,1,"","merge"],[20,2,1,"","n"],[20,1,1,"","serialize"],[20,1,1,"","to_string"],[20,1,1,"","update"]],"datasketches.frequent_items_error_type":[[6,3,1,"","NO_FALSE_NEGATIVES"],[6,3,1,"","NO_FALSE_POSITIVES"]],"datasketches.frequent_items_sketch":[[6,1,1,"","__init__"],[6,1,1,"","deserialize"],[6,2,1,"","epsilon"],[6,1,1,"","get_apriori_error"],[6,1,1,"","get_epsilon_for_lg_size"],[6,1,1,"","get_estimate"],[6,1,1,"","get_frequent_items"],[6,1,1,"","get_lower_bound"],[6,1,1,"","get_serialized_size_bytes"],[6,1,1,"","get_upper_bound"],[6,1,1,"","is_empty"],[6,1,1,"","merge"],[6,2,1,"","num_active_items"],[6,1,1,"","serialize"],[6,1,1,"","to_string"],[6,2,1,"","total_weight"],[6,1,1,"","update"]],"datasketches.frequent_strings_sketch":[[6,1,1,"","__init__"],[6,1,1,"","deserialize"],[6,2,1,"","epsilon"],[6,1,1,"","get_apriori_error"],[6,1,1,"","get_epsilon_for_lg_size"],[6,1,1,"","get_estimate"],[6,1,1,"","get_frequent_items"],[6,1,1,"","get_lower_bound"],[6,1,1,"","get_serialized_size_bytes"],[6,1,1,"","get_upper_bound"],[6,1,1,"","is_empty"],[6,1,1,"","merge"],[6,2,1,"","num_active_items"],[6,1,1,"","serialize"],[6,1,1,"","to_string"],[6,2,1,"","total_weight"],[6,1,1,"","update"]],"datasketches.kll_doubles_sketch":[[16,1,1,"","__init__"],[16,1,1,"","deserialize"],[16,1,1,"","get_cdf"],[16,1,1,"","get_max_value"],[16,1,1,"","get_min_value"],[16,1,1,"","get_normalized_rank_error"],[16,1,1,"","get_pmf"],[16,1,1,"","get_quantile"],[16,1,1,"","get_quantiles"],[16,1,1,"","get_rank"],[16,1,1,"","is_empty"],[16,1,1,"","is_estimation_mode"],[16,2,1,"","k"],[16,1,1,"","merge"],[16,2,1,"","n"],[16,1,1,"","normalized_rank_error"],[16,2,1,"","num_retained"],[16,1,1,"","serialize"],[16,1,1,"","to_string"],[16,1,1,"","update"]],"datasketches.kll_floats_sketch":[[16,1,1,"","__init__"],[16,1,1,"","deserialize"],[16,1,1,"","get_cdf"],[16,1,1,"","get_max_value"],[16,1,1,"","get_min_value"],[16,1,1,"","get_normalized_rank_error"],[16,1,1,"","get_pmf"],[16,1,1,"","get_quantile"],[16,1,1,"","get_quantiles"],[16,1,1,"","get_rank"],[16,1,1,"","is_empty"],[16,1,1,"","is_estimation_mode"],[16,2,1,"","k"],[16,1,1,"","merge"],[16,2,1,"","n"],[16,1,1,"","normalized_rank_error"],[16,2,1,"","num_retained"],[16,1,1,"","serialize"],[16,1,1,"","to_string"],[16,1,1,"","update"]],"datasketches.kll_ints_sketch":[[16,1,1,"","__init__"],[16,1,1,"","deserialize"],[16,1,1,"","get_cdf"],[16,1,1,"","get_max_value"],[16,1,1,"","get_min_value"],[16,1,1,"","get_normalized_rank_error"],[16,1,1,"","get_pmf"],[16,1,1,"","get_quantile"],[16,1,1,"","get_quantiles"],[16,1,1,"","get_rank"],[16,1,1,"","is_empty"],[16,1,1,"","is_estimation_mode"],[16,2,1,"","k"],[16,1,1,"","merge"],[16,2,1,"","n"],[16,1,1,"","normalized_rank_error"],[16,2,1,"","num_retained"],[16,1,1,"","serialize"],[16,1,1,"","to_string"],[16,1,1,"","update"]],"datasketches.kll_items_sketch":[[16,1,1,"","__init__"],[16,1,1,"","deserialize"],[16,1,1,"","get_cdf"],[16,1,1,"","get_max_value"],[16,1,1,"","get_min_value"],[16,1,1,"","get_normalized_rank_error"],[16,1,1,"","get_pmf"],[16,1,1,"","get_quantile"],[16,1,1,"","get_quantiles"],[16,1,1,"","get_rank"],[16,1,1,"","is_empty"],[16,1,1,"","is_estimation_mode"],[16,2,1,"","k"],[16,1,1,"","merge"],[16,2,1,"","n"],[16,1,1,"","normalized_rank_error"],[16,2,1,"","num_retained"],[16,1,1,"","serialize"],[16,1,1,"","to_string"],[16,1,1,"","update"]],"datasketches.quantiles_doubles_sketch":[[17,1,1,"","__init__"],[17,1,1,"","deserialize"],[17,1,1,"","get_cdf"],[17,1,1,"","get_max_value"],[17,1,1,"","get_min_value"],[17,1,1,"","get_normalized_rank_error"],[17,1,1,"","get_pmf"],[17,1,1,"","get_quantile"],[17,1,1,"","get_quantiles"],[17,1,1,"","get_rank"],[17,1,1,"","is_empty"],[17,1,1,"","is_estimation_mode"],[17,2,1,"","k"],[17,1,1,"","merge"],[17,2,1,"","n"],[17,1,1,"","normalized_rank_error"],[17,2,1,"","num_retained"],[17,1,1,"","serialize"],[17,1,1,"","to_string"],[17,1,1,"","update"]],"datasketches.quantiles_floats_sketch":[[17,1,1,"","__init__"],[17,1,1,"","deserialize"],[17,1,1,"","get_cdf"],[17,1,1,"","get_max_value"],[17,1,1,"","get_min_value"],[17,1,1,"","get_normalized_rank_error"],[17,1,1,"","get_pmf"],[17,1,1,"","get_quantile"],[17,1,1,"","get_quantiles"],[17,1,1,"","get_rank"],[17,1,1,"","is_empty"],[17,1,1,"","is_estimation_mode"],[17,2,1,"","k"],[17,1,1,"","merge"],[17,2,1,"","n"],[17,1,1,"","normalized_rank_error"],[17,2,1,"","num_retained"],[17,1,1,"","serialize"],[17,1,1,"","to_string"],[17,1,1,"","update"]],"datasketches.quantiles_ints_sketch":[[17,1,1,"","__init__"],[17,1,1,"","deserialize"],[17,1,1,"","get_cdf"],[17,1,1,"","get_max_value"],[17,1,1,"","get_min_value"],[17,1,1,"","get_normalized_rank_error"],[17,1,1,"","get_pmf"],[17,1,1,"","get_quantile"],[17,1,1,"","get_quantiles"],[17,1,1,"","get_rank"],[17,1,1,"","is_empty"],[17,1,1,"","is_estimation_mode"],[17,2,1,"","k"],[17,1,1,"","merge"],[17,2,1,"","n"],[17,1,1,"","normalized_rank_error"],[17,2,1,"","num_retained"],[17,1,1,"","serialize"],[17,1,1,"","to_string"],[17,1,1,"","update"]],"datasketches.quantiles_items_sketch":[[17,1,1,"","__init__"],[17,1,1,"","deserialize"],[17,1,1,"","get_cdf"],[17,1,1,"","get_max_value"],[17,1,1,"","get_min_value"],[17,1,1,"","get_normalized_rank_error"],[17,1,1,"","get_pmf"],[17,1,1,"","get_quantile"],[17,1,1,"","get_quantiles"],[17,1,1,"","get_rank"],[17,1,1,"","is_empty"],[17,1,1,"","is_estimation_mode"],[17,2,1,"","k"],[17,1,1,"","merge"],[17,2,1,"","n"],[17,1,1,"","normalized_rank_error"],[17,2,1,"","num_retained"],[17,1,1,"","serialize"],[17,1,1,"","to_string"],[17,1,1,"","update"]],"datasketches.req_floats_sketch":[[18,1,1,"","__init__"],[18,1,1,"","deserialize"],[18,1,1,"","get_RSE"],[18,1,1,"","get_cdf"],[18,1,1,"","get_max_value"],[18,1,1,"","get_min_value"],[18,1,1,"","get_pmf"],[18,1,1,"","get_quantile"],[18,1,1,"","get_quantiles"],[18,1,1,"","get_rank"],[18,1,1,"","get_rank_lower_bound"],[18,1,1,"","get_rank_upper_bound"],[18,1,1,"","is_empty"],[18,1,1,"","is_estimation_mode"],[18,1,1,"","is_hra"],[18,2,1,"","k"],[18,1,1,"","merge"],[18,2,1,"","n"],[18,2,1,"","num_retained"],[18,1,1,"","serialize"],[18,1,1,"","to_string"],[18,1,1,"","update"]],"datasketches.req_ints_sketch":[[18,1,1,"","__init__"],[18,1,1,"","deserialize"],[18,1,1,"","get_RSE"],[18,1,1,"","get_cdf"],[18,1,1,"","get_max_value"],[18,1,1,"","get_min_value"],[18,1,1,"","get_pmf"],[18,1,1,"","get_quantile"],[18,1,1,"","get_quantiles"],[18,1,1,"","get_rank"],[18,1,1,"","get_rank_lower_bound"],[18,1,1,"","get_rank_upper_bound"],[18,1,1,"","is_empty"],[18,1,1,"","is_estimation_mode"],[18,1,1,"","is_hra"],[18,2,1,"","k"],[18,1,1,"","merge"],[18,2,1,"","n"],[18,2,1,"","num_retained"],[18,1,1,"","serialize"],[18,1,1,"","to_string"],[18,1,1,"","update"]],"datasketches.req_items_sketch":[[18,1,1,"","__init__"],[18,1,1,"","deserialize"],[18,1,1,"","get_RSE"],[18,1,1,"","get_cdf"],[18,1,1,"","get_max_value"],[18,1,1,"","get_min_value"],[18,1,1,"","get_pmf"],[18,1,1,"","get_quantile"],[18,1,1,"","get_quantiles"],[18,1,1,"","get_rank"],[18,1,1,"","get_rank_lower_bound"],[18,1,1,"","get_rank_upper_bound"],[18,1,1,"","is_empty"],[18,1,1,"","is_estimation_mode"],[18,1,1,"","is_hra"],[18,2,1,"","k"],[18,1,1,"","merge"],[18,2,1,"","n"],[18,2,1,"","num_retained"],[18,1,1,"","serialize"],[18,1,1,"","to_string"],[18,1,1,"","update"]],"datasketches.tdigest_double":[[19,1,1,"","__init__"],[19,1,1,"","compress"],[19,1,1,"","deserialize"],[19,1,1,"","get_cdf"],[19,1,1,"","get_max_value"],[19,1,1,"","get_min_value"],[19,1,1,"","get_pmf"],[19,1,1,"","get_quantile"],[19,1,1,"","get_rank"],[19,1,1,"","get_serialized_size_bytes"],[19,1,1,"","get_total_weight"],[19,1,1,"","is_empty"],[19,2,1,"","k"],[19,1,1,"","merge"],[19,1,1,"","serialize"],[19,1,1,"","to_string"],[19,1,1,"","update"]],"datasketches.tdigest_float":[[19,1,1,"","__init__"],[19,1,1,"","compress"],[19,1,1,"","deserialize"],[19,1,1,"","get_cdf"],[19,1,1,"","get_max_value"],[19,1,1,"","get_min_value"],[19,1,1,"","get_pmf"],[19,1,1,"","get_quantile"],[19,1,1,"","get_rank"],[19,1,1,"","get_serialized_size_bytes"],[19,1,1,"","get_total_weight"],[19,1,1,"","is_empty"],[19,2,1,"","k"],[19,1,1,"","merge"],[19,1,1,"","serialize"],[19,1,1,"","to_string"],[19,1,1,"","update"]],"datasketches.theta_a_not_b":[[3,1,1,"","__init__"],[3,1,1,"","compute"]],"datasketches.theta_intersection":[[3,1,1,"","__init__"],[3,1,1,"","get_result"],[3,1,1,"","has_result"],[3,1,1,"","update"]],"datasketches.theta_jaccard_similarity":[[9,1,1,"","dissimilarity_test"],[9,1,1,"","exactly_equal"],[9,1,1,"","jaccard"],[9,1,1,"","similarity_test"]],"datasketches.theta_sketch":[[3,1,1,"","get_estimate"],[3,1,1,"","get_lower_bound"],[3,1,1,"","get_seed_hash"],[3,1,1,"","get_upper_bound"],[3,1,1,"","is_empty"],[3,1,1,"","is_estimation_mode"],[3,1,1,"","is_ordered"],[3,2,1,"","num_retained"],[3,2,1,"","theta"],[3,2,1,"","theta64"],[3,1,1,"","to_string"]],"datasketches.theta_union":[[3,1,1,"","__init__"],[3,1,1,"","get_result"],[3,1,1,"","update"]],"datasketches.tuple_a_not_b":[[4,1,1,"","__init__"],[4,1,1,"","compute"]],"datasketches.tuple_intersection":[[4,1,1,"","__init__"],[4,1,1,"","get_result"],[4,1,1,"","has_result"],[4,1,1,"","update"]],"datasketches.tuple_jaccard_similarity":[[9,1,1,"","dissimilarity_test"],[9,1,1,"","exactly_equal"],[9,1,1,"","jaccard"],[9,1,1,"","similarity_test"]],"datasketches.tuple_sketch":[[4,3,1,"","DEFAULT_SEED"],[4,1,1,"","get_estimate"],[4,1,1,"","get_lower_bound"],[4,1,1,"","get_seed_hash"],[4,1,1,"","get_upper_bound"],[4,1,1,"","is_empty"],[4,1,1,"","is_estimation_mode"],[4,1,1,"","is_ordered"],[4,2,1,"","num_retained"],[4,2,1,"","theta"],[4,2,1,"","theta64"],[4,1,1,"","to_string"]],"datasketches.tuple_union":[[4,1,1,"","__init__"],[4,1,1,"","get_result"],[4,1,1,"","reset"],[4,1,1,"","update"]],"datasketches.update_theta_sketch":[[3,1,1,"","__init__"],[3,1,1,"","compact"],[3,1,1,"","reset"],[3,1,1,"","trim"],[3,1,1,"","update"]],"datasketches.update_tuple_sketch":[[4,1,1,"","__init__"],[4,1,1,"","compact"],[4,1,1,"","filter"],[4,1,1,"","reset"],[4,1,1,"","trim"],[4,1,1,"","update"]],"datasketches.var_opt_sketch":[[22,1,1,"","__init__"],[22,1,1,"","deserialize"],[22,1,1,"","estimate_subset_sum"],[22,1,1,"","get_serialized_size_bytes"],[22,1,1,"","is_empty"],[22,2,1,"","k"],[22,2,1,"","n"],[22,2,1,"","num_samples"],[22,1,1,"","serialize"],[22,1,1,"","to_string"],[22,1,1,"","update"]],"datasketches.var_opt_union":[[22,1,1,"","__init__"],[22,1,1,"","deserialize"],[22,1,1,"","get_result"],[22,1,1,"","get_serialized_size_bytes"],[22,1,1,"","reset"],[22,1,1,"","serialize"],[22,1,1,"","to_string"],[22,1,1,"","update"]]},"objnames":{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","property","Python property"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"]},"objtypes":{"0":"py:class","1":"py:method","2":"py:property","3":"py:attribute","4":"py:function"},"terms":{"01668v2":18,"1e":6,"1e9":6,"50th":17,"93smirnov_test":11,"95th":17,"A":[1,3,4,6,10,11,12,13,16,17,22],"All":[12,13],"An":[3,4,9,10,12,13,20],"As":[0,17],"Both":21,"Each":[12,13,18],"For":[0,1,5,6,16,17,18,19,24],"From":[16,17],"If":[1,6,9,16,17,18,19],"In":[0,1,16,20],"It":[3,16,17,18,19],"More":[0,6],"Most":17,"Some":8,"That":15,"The":[0,1,2,3,4,5,6,7,10,11,12,13,15,16,17,18,19,20,21,22,23],"Then":16,"There":[3,6],"These":[1,8,9,15,21,24],"This":[0,1,6,12,14,16,17,18,20],"Those":15,"When":18,"With":[16,17,18],"_":11,"__call__":[10,13],"__eq__":6,"__hash__":6,"__init__":[0,1,3,4,6,16,17,18,19,20,22,23],"__lt__":[16,17,18],"_datasketch":[0,1,3,4,5,6,9,11,16,17,18,19,20,22,23],"ab":18,"abbadi":6,"abc":[4,16,17,18,19,22,23],"abil":18,"abov":[7,16],"absolut":8,"abstract":[3,4,8,10,12,13],"accept":24,"account":11,"accumulatori":13,"accumulatorpolici":13,"accur":19,"accuraci":[0,1,2,3,5,6,16,17,18,19],"achiev":5,"activ":[6,14],"actual":[9,17],"add":[13,16],"addit":[0,2,6,12,16],"advanc":21,"affect":[16,17],"agraw":6,"algorithm":[0,1,2,3,6,14,18,19],"alloc":12,"allow":[0,4,12,13,18],"along":6,"also":[0,3,10,14,15,17,19],"altern":[15,19],"although":[1,19,20],"alway":[6,13,16,17,20,21],"analog":[16,17,18,19],"analysi":[4,11,16,17,18],"analyz":14,"ani":[3,4,5,6,7,13,16,17],"anoth":[0,6,18],"answer":15,"appl":0,"appli":[2,3,4,6,13,15,16,18,21,22],"applic":2,"approach":15,"approx":[5,18],"approxim":[0,1,3,4,5,6,10,15,16,17,18,19,23],"arbitrari":[4,6],"arg":[0,1,3,4,5,6,10,12,13,16,17,18,19,20,22,23],"arg0":3,"arg1":3,"around":16,"array":[6,10,16,17,18,19],"art":2,"arxiv":18,"as_pmf":[16,17],"associ":[4,6,16,17,18,19],"assum":[6,11],"aux_detail":1,"avail":16,"avoid":3,"axi":16,"b":[3,4,10,20],"back":0,"background":6,"backward":[6,15],"bag":6,"bandwidth":10,"base":[0,1,2,3,4,5,6,8,10,12,13,15,18,19,20,21,23],"basi":[10,19],"basic":[3,4,10],"becaus":16,"befor":[6,7],"behavior":1,"best":[16,17],"better":[1,2,3],"beyond":3,"bias":19,"big":14,"bin":[0,16],"binari":[12,17],"bit":[0,1,3,4,5,12,17],"blob":23,"bool":[0,1,3,4,5,6,9,11,16,17,18,19,20,22,23],"bound":[0,1,3,4,5,6,9,14,15,16,18,21,22],"bracket":16,"bucket":[1,5],"buffer":19,"build":23,"byte":[0,1,3,4,5,6,12,16,17,18,19,20,22,23],"c":[0,20],"call":[16,20],"callabl":[4,22],"came":2,"can":[0,1,3,4,6,11,13,15,16,17,18,19],"capabl":[0,6,18],"capac":6,"cardin":[0,3],"case":[1,6,8,17,20],"caus":6,"cdf":[16,17,18,19],"cdfs":15,"centroid":19,"certain":[7,8,10,16,20],"characterist":19,"choic":1,"choos":18,"chosen":19,"class":[0,1,3,4,5,6,9,10,12,13,16,17,18,19,20,22,23],"classic":[15,17],"close":[7,19],"closest":19,"cm":5,"code":[6,18],"collect":[1,4,16,17,18,19,22,23],"com":23,"combin":[8,13],"come":[11,17],"common":[6,16,19],"compact":[1,3,4,15,16,18],"compact_theta_sketch":3,"compact_tuple_sketch":4,"compactor":18,"compar":[0,16,17,18],"comparison":[0,18],"compat":[6,12,15,17],"complic":4,"compress":[1,2,3,14,19],"comput":[3,4,6,8,9,15,19,20,22,23],"concept":2,"concret":8,"confid":[5,9,16,17],"configur":[0,1,5,16,17,18,19,20,22,23],"consecut":[16,17,18,19],"consid":[9,17],"consist":13,"constant":[1,6,16,17,18],"construct":[1,18,22],"consum":[1,12],"contain":[3,6,7],"context":10,"contrast":[5,20],"control":[16,17,18,19,23],"coreset":23,"cormod":[5,18],"correspond":[0,1,3,4,5,6,16,17,18,20,22,23],"cost":[1,12],"count":[1,3,4,6,17,18],"count_min_sketch":[5,7],"counter":6,"countmin":[7,14],"coupon":1,"cpc":[1,2,14],"cpc_sketch":[0,2],"cpc_union":0,"creat":[0,3,4,6,13,16,17,18,19,20,22,23],"create_summari":13,"creation":20,"criterion":18,"critic":12,"cross":[12,17],"cumul":[15,16,17,18,19],"current":[1,3,4,5,6,7,11,15,20,22],"custom":[4,10,12,13],"data":[2,3,6,11,12,13,14,15,16,17,18,19,20,22,23],"datasketch":[2,11,19],"datum":[0,1,3,4],"debug":18,"decreas":[15,18],"decrement":6,"dedic":[3,4],"default":[1,3,4,10,16,17,18,19],"default_se":4,"defin":[3,4,6,10,16,20],"definit":[16,17,18],"delta":5,"demain":6,"denot":[5,6],"densiti":[8,10,14,24],"density_sketch":[10,23,24],"depend":[5,16,19],"deprec":[14,15],"derial":19,"deriv":[3,16,17,18],"describ":[0,5,18,19],"deseri":[0,1,3,4,5,6,8,14,16,17,18,19,20,22,23],"design":[15,24],"desing":22,"detail":[1,18,21],"determin":[7,11],"determinist":6,"develop":[0,14],"deviat":[0,1,3,4,18],"dict":22,"differ":[0,1,2,3,6,12,13,18,19,21],"digest":[14,15],"dim":23,"dimac":5,"dimens":[0,23],"dimension":16,"discov":6,"discrep":23,"discuss":18,"disjoint":[16,17,18,19],"dissimilar":9,"dissimilarity_test":9,"distanc":23,"distinct":[0,1,3,4,6],"distribut":[1,11,15,16,17,18,19],"divid":[16,17,18,19],"document":16,"doe":[0,5,6,7,15,16,18,19,21],"domain":[16,19],"doubl":[16,17,18,20],"dtype":[16,17,18,19],"dun":19,"dure":1,"e":15,"e2":11,"earliest":2,"easili":[3,4],"ebpp":[14,21],"ebpps_sketch":[20,21],"edg":[16,17],"edo":[18,23],"edoliberti":23,"edu":5,"effect":[3,4,19],"effici":[0,3,6,14],"either":[6,15,16,17,18,19],"element":[2,6],"els":18,"empir":[0,16,17,18,19],"employ":6,"empti":[0,1,3,4,6,16,17,18,19,20,22,23],"en":11,"enabl":[16,17],"encod":12,"end":[15,19],"endian":12,"enough":1,"ensur":[6,20,21],"entir":[7,15,21],"entri":[1,3,4,6],"entropi":0,"ep":16,"epsilon":[6,16],"equal":[11,15,16,17,18,20],"equival":[9,17,20,22],"err_typ":6,"error":[1,3,5,6,8,11,14,15,16,17,19,20,22,23],"ertl":19,"estim":[0,1,2,3,4,5,6,7,8,9,10,15,16,17,18,19,22,23,24],"estimate_subset_sum":22,"estimated_total_stream_weight":6,"estimated_total_weight":6,"evalu":[4,10],"even":[0,21],"everi":[3,4,5,6],"exact":[6,14,21],"exactly_equ":9,"exampl":[4,5,6,8,10,12,17],"exceed":[6,18,20],"excel":19,"except":[1,16,17,18],"excess":[3,4],"exclud":6,"exclus":[16,17,18],"exist":[3,4,13],"expect":[9,20],"expens":6,"express":18,"extend":[12,13],"extens":[4,18],"extern":6,"extrem":[0,6,19],"f688c8161a25582457b0a09deb4630a81406293b":23,"f_x":5,"factor":18,"failur":5,"fals":[0,1,3,4,5,6,9,11,16,17,18,19,20,22,23],"famili":[1,8,11,19],"far":[6,15,16,17,18,19,20],"fast":0,"favor":[15,17],"fed":1,"feed":[20,22],"fewer":[6,20,22],"field":6,"filter":4,"find":6,"fit":[16,17],"fix":4,"flag":[16,17],"flajolet":[1,2],"flavor":[1,6],"float":[0,1,3,4,5,6,9,10,11,12,15,16,17,18,19,20,22,23],"float32":[16,17,18,19],"float64":[16,17,19],"fm85":0,"follow":[6,16,18,23],"footprint":2,"form":[3,4,6,11],"format":[12,19],"found":6,"four":15,"fraction":[3,4,16,17,20],"framework":3,"frequenc":[5,6,17],"frequent":[5,7,14],"frequent_items_error_typ":6,"frequent_items_sketch":[6,7],"frequent_strings_sketch":[6,7],"from_byt":12,"full":[1,5],"funciton":10,"function":[0,1,3,4,5,6,8,11,14,15,16,17,18,19],"futur":0,"g":15,"gaussian":10,"gaussiankernel":10,"gde":23,"general":15,"generat":[16,17,18],"generic":[6,7,10,15],"get":[16,17],"get_apriori_error":6,"get_cdf":[16,17,18,19],"get_compact_serialization_byt":1,"get_epsilon_for_lg_s":6,"get_estim":[0,1,3,4,5,6,23],"get_frequent_item":6,"get_lower_bound":[0,1,3,4,5,6],"get_max_updatable_serialization_byt":1,"get_max_valu":[16,17,18,19],"get_min_valu":[16,17,18,19],"get_n":17,"get_normalized_rank_error":[16,17,18],"get_pmf":[16,17,18,19],"get_quantil":[16,17,18,19],"get_rank":[16,17,18,19],"get_rank_lower_bound":18,"get_rank_upper_bound":18,"get_rel_err":1,"get_relative_error":5,"get_result":[0,1,3,4,20,22],"get_rs":18,"get_seed_hash":[3,4],"get_serialized_size_byt":[5,6,19,20,22],"get_siz":12,"get_total_weight":19,"get_updatable_serialization_byt":1,"get_upper_bound":[0,1,3,4,5,6],"github":23,"given":[0,1,3,4,5,6,10,11,12,15,16,17,18,19,20,22,23],"global":[6,15],"good":[2,3,15],"graham":[5,18],"gri":6,"grow":6,"guarante":[5,6,15,16,17,18],"haa":20,"handl":[3,7,20],"has_result":[3,4],"hash":[0,3,4,5,6],"hat":5,"heavi":[5,6,7,14],"heaviest":7,"help":[9,18],"hentschel":20,"heurist":15,"high":[0,1,14,15,18,19],"higher":[1,17],"highest":1,"hip":0,"histogram":[15,17],"histor":[0,15],"hitter":[5,6,7,14],"hll":[0,2,14],"hll_4":1,"hll_6":1,"hll_8":1,"hll_sketch":[1,2],"hll_union":1,"hold":[1,6,19],"howev":[6,16,18,19],"http":[5,18],"https":[11,23],"hyper":2,"hyperloglog":[0,2,3,14],"hypothesi":11,"hypothet":[16,17,18,19],"icon":0,"identifi":7,"imag":5,"implement":[0,1,4,6,7,10,12,13,16,17,18,19,23],"improv":[1,22],"includ":[15,16,17,18,19,20,21,22],"inclus":[1,16,17,18,21],"incom":[3,4,6],"increas":[16,17,18,19],"increment":6,"independ":16,"index":[9,14,16,17],"indic":[1,10],"inform":[19,20],"inherit":10,"init_number_of_sect":18,"initi":[1,3,4,6,18],"input":[0,1,3,4,6,10,11,16,17,18,19,21,23,24],"insert":[3,5,6],"inspir":23,"instanc":[6,16,17,18,19,20,22,23],"instead":[17,18],"insuffici":11,"int":[0,1,3,4,5,6,9,12,16,17,18,19,20,22,23],"int32":[16,17,18],"integ":[0,5,6,12,13,15],"integr":[1,3,4],"internal":6,"internet":6,"interpol":19,"interpret":16,"intersect":[2,3,4,13],"interval":[16,17,18,19],"introduc":6,"invers":[0,16],"involv":7,"is_compact":1,"is_empti":[0,1,3,4,5,6,16,17,18,19,20,22,23],"is_estimation_mod":[3,4,16,17,18,23],"is_hra":18,"is_ord":[3,4],"item":[1,3,4,5,7,12,14,15,16,17,18,19,20,21,22,23],"iter":20,"j":20,"j_":9,"jaccard":[3,4,8,14],"java":17,"job":15,"just":16,"justin":18,"k":[0,1,2,3,4,6,7,16,17,18,19,20,22,23],"kappa":0,"karnin":[18,23],"karnin19a":23,"karp":6,"keep":[1,4,20],"kept":13,"kernel":[8,14,23,24],"kernel_funct":8,"kernel_sketch":8,"kernelfunct":[10,23],"kevin":0,"key":[2,4],"kll":[14,15,17],"kll_doubles_sketch":[11,16],"kll_floats_sketch":[11,16],"kll_ints_sketch":[11,16],"kll_items_sketch":[11,16],"known":[0,2,6,10,14,21],"kolmogorov":[8,14],"ks_test":[8,11],"kwarg":[0,1,3,4,5,6,10,12,13,16,17,18,19,20,22,23],"lang":0,"languag":[12,17],"larg":[1,15,16,17],"larger":[2,16,20],"largest":13,"last":[16,17,18],"lazi":16,"lb":[6,9],"le":5,"learn":[10,23],"least":[6,8],"left":[16,17,18],"legaci":6,"lemma":18,"len":12,"length":[6,16,17,18,20,21,22,23],"less":[15,16,17,18],"let":16,"letter":20,"level":[5,18],"leverag":1,"lg_config_k":1,"lg_k":[0,1,3,4],"lg_max_k":[1,6],"lg_max_map_s":6,"liberti":[18,23],"librari":[2,4,6,7,10,11,15,19,24],"like":[1,7,11,16],"limit":[6,20],"line":[16,17,18,19],"list":[5,6,7,9,16,17,18,19],"littl":12,"load_factor":6,"log":[1,2],"log2":[1,6],"logarithm":[0,3,4,6],"logic":[6,15],"longer":2,"look":6,"loos":18,"lopez":6,"low":[15,18,19],"lower":[0,1,3,4,5,6,9,16,18,19,22],"lower_bound":9,"m":[6,16,17,18,19],"machin":[10,23],"maintain":[3,7],"make":16,"mani":[3,19],"map":6,"mapcap":6,"mapsiz":6,"margin":20,"martin":2,"mass":[15,16,17,18,19],"mass_i":16,"match":[0,3,4,22],"mathemat":[10,18,19],"max":[13,16,17,18,19],"max_k":22,"max_map_s":6,"maximum":[1,3,4,5,6,16,17,18,19,20,22],"maxintpolici":13,"maxmapcap":6,"maxmaps":6,"may":[5,6,14,15,16,18,20],"mean":[4,6,16,17,20],"measur":[3,4,9,16,17,18,19],"median":[6,17,19],"member":[3,6],"memori":[1,2,6],"merg":[0,1,4,5,6,16,17,18,19,20,23],"mergingdigest":19,"method":[0,1,3,4,5,6,10,12,16,17,18,19,20,22,23],"metwal":6,"middl":19,"might":[6,16],"million":17,"min":[13,16,17,18,19],"minim":21,"minimum":[2,3,16,17,18,19,22],"minintpolici":13,"misra":6,"miss":6,"mlr":23,"mode":[1,3,4,16,17,18,23],"modifi":[11,18,19],"modul":14,"monoton":[16,17,18,19],"much":[1,6],"multipli":17,"multiset":6,"munro":6,"must":[1,3,4,10,12,13,16,17,18],"muthukrishnan":5,"n":[1,16,17,18,20,22,23],"name":6,"nan":[16,17,18],"natur":[16,17],"ndarray":[16,17,18,19],"near":[0,16,17],"necessari":[16,17,18,19],"necessarili":7,"necesssari":19,"need":[3,5,6,13,20,21,22],"network":17,"never":[5,6,16,18],"new":[0,1,6,13,17,20,22,23],"newli":0,"no_false_neg":6,"no_false_posit":6,"node":17,"nomin":[3,4,18],"non":[0,1,3,4,5,6,16,17,18,19,20,22,23],"none":[0,1,3,4,5,6,16,17,18,19,20,22,23],"normal":[16,17,18,19],"normalized_rank_error":[16,17],"note":[6,9,11,16,18],"novemb":17,"now":24,"null":[11,12],"num_active_item":6,"num_bucket":5,"num_byt":12,"num_hash":5,"num_retain":[3,4,16,17,18,23],"num_sampl":22,"num_std_dev":[1,3,4,18],"number":[0,1,2,3,4,5,6,12,16,17,18,19,20,22,23],"numer":[15,19,20],"numpi":10,"numsect":18,"object":[0,1,3,4,5,6,7,9,10,12,13,16,17,18,19,20,22,23],"obtain":[5,16,17,18],"occurr":5,"offer":[1,2,7],"offest":12,"offs":1,"offset":12,"often":7,"one":[2,5,6,7,8,16,17,18,19,23],"onli":[1,6,15,16,17,18,19,24],"oper":[0,2,3,4,13,16,18,19],"opposit":16,"opt":22,"optim":[0,14,16,21],"option":[0,3,4,6,16,17,18,19,20,22],"order":[3,4,5,13,15,20],"org":[11,18],"ortiz":6,"otherwis":[0,1,3,4,5,6,9,11,16,17,18,19,20,22,23],"otmar":19,"output":18,"outsid":7,"overal":17,"overestim":[5,19],"overload":[0,1,3,4,5,11,16,17,18,19],"overrid":[10,12],"p":[3,4,11,20],"packag":3,"packet":[6,17],"page":[14,19],"pair":[6,8,11],"papadimitriou":6,"paper":[0,3,5,18,19,23],"paramet":[0,1,3,4,5,6,10,12,13,16,17,18,19,20,22,23],"partial":20,"particular":[10,18],"pass":[16,17],"pattern":10,"pavel":18,"pdf":[5,23],"per":[1,16],"percentag":7,"percentil":[16,17],"perform":[0,1,2,3,4,8,10,11,16,18,19],"permiss":5,"phillip":1,"physic":6,"plot":16,"plus":6,"pmf":[16,17,18,19],"pmfs":15,"point":[0,1,3,4,10,12,15,16,17,18,19,20,23],"polici":[4,8,14],"portion":[15,20],"posit":6,"possibl":0,"power":[6,18],"pps":20,"practic":[3,6],"pre":12,"precis":[17,20],"predic":[4,21,22],"present":22,"press":23,"print":[20,22],"print_centroid":19,"print_item":[3,4,6,16,17,18,20,22,23],"print_level":[16,17,18,23],"priori":[1,6,18],"priorit":19,"probabilist":[1,2,5,14,15,16,17,18],"probabilitiy":[14,21],"probabl":[0,5,6,15,16,17,18,19,20,21,22],"problem":14,"proceed":23,"process":[19,20,22],"produc":[0,1,3,4,5,6,16,17,18,19,20,22,23],"project":[14,17],"pronounc":19,"proof":6,"properti":[0,1,2,3,4,5,6,15,16,17,18,19,20,22,23],"proport":[14,21],"prototyp":18,"proven":15,"provid":[0,1,2,3,4,5,6,7,9,10,11,12,13,15,16,17,18,19,22,23,24],"pub":5,"purg":6,"py":23,"pydoublesserd":12,"pyfloatsserd":12,"pyintsserd":12,"pylongsserd":12,"pyobjectserd":[4,6,12,16,17,18,20,22],"pystringsserd":12,"python":[13,18],"q":16,"q_hi":16,"q_lo":16,"qualifi":6,"quantil":[8,16,19,23],"quantiles_doubles_sketch":[11,17],"quantiles_floats_sketch":[11,17],"quantiles_ints_sketch":[11,17],"quantiles_items_sketch":[11,17],"queri":[5,15,16,17,22],"quick":14,"quit":[0,4,15,16],"r":16,"r1":16,"r2":16,"r_":16,"r_i":16,"radial":10,"random":[6,20],"rang":15,"rank":[15,16,17,18,19],"rate":[3,4],"reach":[1,6],"read":[0,1,3,4,5,6,12,19,20,22,23],"real":[16,17,18,19],"reason":1,"rebuild":6,"receiv":[1,17],"recognit":10,"recommend":1,"reconstruct":12,"redesign":6,"rediscov":6,"refer":[6,8,12,16,19],"reflect":11,"regardless":7,"reject":11,"relat":[1,5,7,9,14,15,20,21,22],"relationship":16,"relative_error":5,"relev":13,"reli":10,"remain":18,"remov":[3,4,6],"repeat":6,"repres":[1,17,20],"req":[14,15,17,19],"req_floats_sketch":18,"req_ints_sketch":18,"req_items_sketch":18,"requir":[4,5,6,8,16,17,18,20,22,23],"reservoir":[20,22],"reset":[1,3,4,22],"respect":[16,17],"result":[0,3,4,6,16,17,18,19,21,22],"retain":[3,4,6,16,17,18,23],"retun":12,"return":[0,1,3,4,5,6,9,10,11,12,13,16,17,18,19,20,22,23],"right":[4,16,17,18],"rough":[0,22],"round":18,"row":1,"rse":18,"rule":13,"run":6,"runtimeerror":[16,17,18,19],"rutger":5,"s":[1,6,20,21,22],"s1":16,"s2":16,"s_i":16,"s_m":16,"sampl":[3,4,16,17,18,23],"satisfi":5,"scheme":[12,16],"score":10,"search":14,"section":18,"section_s":18,"secur":0,"see":[16,19],"seed":[0,3,4,5,9],"seem":[16,19],"seen":[5,6,7,15,19,20],"select":4,"self":[0,1,3,4,5,6,10,12,13,16,17,18,19,20,22,23],"semin":2,"separ":[3,9,16,17,18],"sequenc":[16,17,18,19,23],"serd":[4,6,8,14,16,17,18,20,22],"serial":[0,1,3,4,5,6,8,14,16,17,18,19,20,22,23],"serialize_compact":1,"serialize_updat":1,"set":[2,3,4,6,13,16,17,18,19,23],"sever":[2,3,4,6,12],"shenker":6,"show":19,"shown":16,"side":[16,17,19],"signific":1,"similar":[2,3,4,8,10,13,14,17,19],"similarity_test":9,"simpl":[2,3,6,12],"simultan":0,"sinc":[6,18],"singl":[16,17],"size":[1,3,4,5,6,11,12,14,16,17,18,19,21,22,23],"sk_1":11,"sk_2":11,"skech":18,"sketch":[0,1,2,6,8,9,11,12,19,20,22],"sketch_a":9,"sketch_b":9,"slight":19,"slot":1,"sm":16,"small":[1,6,11,15],"smaller":[0,1,6,16,22],"smallest":13,"smirnov":[8,14],"snli":7,"solut":2,"sometim":16,"somewhat":[2,21],"sort":[3,4,16,17,18,19],"sourc":[3,4],"sourch":4,"space":[0,1,2,3,6],"special":18,"specif":[6,8,10,15,16,17],"specifi":[0,1,5,6,8,12,13,16,18],"speed":[0,6],"split":[16,17,18,19],"split_point":[16,17,18,19],"sqrt":18,"standard":[0,1,3,4,18],"start":[1,6,12,18],"start_full_s":1,"start_max_s":1,"state":[1,2,3,4,6,18,22],"static":[0,1,3,4,5,6,16,17,18,19,20,22,23],"still":19,"stochast":[16,17],"storag":[1,12,15],"store":[2,3,6],"str":[0,1,3,4,5,6,16,17,18,19,20,22,23],"straightforward":15,"stream":[0,1,3,4,5,6,7,15,16,17,18,19,20,21,22,23],"strict":20,"string":[0,1,3,4,5,6,7,12,16,17,18,19,20,22,23],"string_cont":12,"subset":[21,22],"subtract":16,"suggest":5,"suggest_num_bucket":5,"suggest_num_hash":5,"sum":[6,16,17,18,21,22],"summari":[0,1,3,4,5,6,8,13,16,17,18,19,20,22,23],"support":[2,6,19],"surviv":0,"t":[14,15,17],"tabl":[1,6],"take":11,"target":1,"target_hll_typ":1,"task":2,"tdigest":19,"tdigest_doubl":19,"tdigest_float":19,"ted":19,"templat":17,"tend":19,"term":1,"termin":12,"test":[8,9,14],"tgt_hll_type":1,"tgt_type":1,"thaler":18,"theta":[1,2,4,8,9,14],"theta64":[3,4],"theta_a_not_b":3,"theta_intersect":3,"theta_jaccard_similar":[3,9],"theta_sketch":[2,3,4,9],"theta_union":3,"thousand":[16,17],"three":[1,12,15],"threshold":[6,9],"throw":[16,17,18,19],"thus":[16,18],"tian":20,"tight":18,"time":[1,6,16,17,18],"to_byt":12,"to_str":[0,1,3,4,5,6,16,17,18,19,20,22,23],"tool":18,"top":[6,7],"topk":14,"total":[5,17,18,19,20,22],"total_weight":[5,6],"toward":19,"track":6,"trade":[1,2,16,17,18,19],"tradeoff":0,"translat":16,"trial":[16,17],"trim":[3,4],"true":[0,1,3,4,5,6,9,11,16,17,18,19,20,22,23],"true_mass":16,"true_rank":16,"tupl":[2,3,8,9,12,14],"tuple_a_not_b":[3,4],"tuple_intersect":4,"tuple_jaccard_similar":[4,9],"tuple_polici":8,"tuple_sketch":[2,4,8,9,13],"tuple_union":4,"tuplepolici":[4,13],"two":[0,6,7,10,11,16,18,23],"type":[1,2,4,6,7,10,11,12,13,15],"typic":[6,15],"ub":[6,9],"underestim":[5,19],"underlying":11,"understand":[15,18],"unequ":20,"uniform":[15,20,22],"union":[0,1,3,4,13,22],"uniqu":[0,1,2,16,17,18,19],"unlik":19,"unsurpris":10,"updat":[0,1,3,4,5,6,13,16,17,18,19,20,22,23],"update_summari":13,"update_theta_sketch":3,"update_tuple_sketch":4,"upon":20,"upper":[0,1,3,4,5,6,9,16,18,22],"upper_bound":[1,9],"us":16,"usag":6,"use":[1,3,4,5,6,8,9,10,11,12,13,15,16,17,18,19,20,21,22,23],"user":[0,10,18],"usual":6,"v99":23,"valid":[3,4,18],"valu":[0,1,2,3,4,5,6,10,11,12,13,15,16,17,18,19,20,22],"var":22,"var_opt_sketch":[21,22],"var_opt_union":22,"variabl":[6,18],"varianc":[14,21],"variant":[3,6,7],"varopt":[14,20,21],"vector":[10,16,17,18,19,23],"veri":[4,6,15,16,17,19],"version":[1,6,7,12,15,16,17,18,19],"vesel\u00fd":18,"via":18,"view":16,"visibl":18,"w":6,"warmup":1,"weight":[5,6,7,16,17,18,19,20,21,22],"well":[0,2,15,19,22],"whether":[1,3,4,18],"whose":7,"wiki":11,"wikipedia":11,"will":[6,11,16,17,18,19,20,21,22],"win":0,"with_buff":19,"within":[5,8],"without":15,"work":[2,15,17,18],"wors":16,"worst":6,"written":[12,18],"x":[5,16],"y":[16,20],"year":6,"yield":16,"zero":16,"zohar":[18,23]},"titles":["Compressed Probabilistic Counting (CPC)","HyperLogLog (HLL)","Distinct Counting","Theta Sketch","Tuple Sketch","CountMin Sketch","Frequent Items","Frequency Sketches","Helper Classes","Jaccard Similarity","Kernel Function","Kolmogorov-Smirnov Test","Serialize/Deserialize (SerDe)","Tuple Policy","Apache DataSketches","Quantiles Sketches","KLL Sketch","Quantiles Sketch (Deprecated)","Relative Error Quantiles (REQ) Sketch","t-digest","Exact and Bounded, Probabilitiy Proportional to Size (EBPPS) Sampling","Random Sampling Sketches","Variance Optimal Sampling (VarOpt)","Density Sketch","Vector Sketches"],"titleterms":{"apach":14,"bound":20,"class":[8,14],"compress":0,"count":[0,2,14],"countmin":5,"cpc":0,"datasketch":14,"densiti":23,"deprec":17,"deseri":12,"digest":19,"distinct":[2,14],"ebpp":20,"error":18,"estim":14,"exact":20,"frequenc":[7,14],"frequent":6,"function":10,"helper":[8,14],"hll":1,"hyperloglog":1,"indic":14,"item":6,"jaccard":9,"kernel":10,"kll":16,"kolmogorov":11,"optim":22,"polici":13,"probabilist":0,"probabilitiy":20,"proport":20,"quantil":[14,15,17,18],"random":[14,21],"relat":18,"req":18,"sampl":[14,20,21,22],"serd":12,"serial":12,"similar":9,"size":20,"sketch":[3,4,5,7,14,15,16,17,18,21,23,24],"smirnov":11,"t":19,"tabl":14,"test":11,"theta":3,"tupl":[4,13],"varianc":22,"varopt":22,"vector":[14,24]}}) \ No newline at end of file
diff --git a/docs/main/vector/density_sketch.html b/docs/main/vector/density_sketch.html index 3344570..d91512b 100644 --- a/docs/main/vector/density_sketch.html +++ b/docs/main/vector/density_sketch.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Density Sketch — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -58,16 +58,16 @@ <li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">density_sketch.deserialize()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.__init__"><code class="docutils literal notranslate"><span class="pre">density_sketch.__init__()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.dim"><code class="docutils literal notranslate"><span class="pre">density_sketch.dim</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">density_sketch.get_estimate</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">density_sketch.is_empty</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">density_sketch.is_estimation_mode</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">density_sketch.get_estimate()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">density_sketch.is_empty()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.is_estimation_mode"><code class="docutils literal notranslate"><span class="pre">density_sketch.is_estimation_mode()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.k"><code class="docutils literal notranslate"><span class="pre">density_sketch.k</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.merge"><code class="docutils literal notranslate"><span class="pre">density_sketch.merge</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.merge"><code class="docutils literal notranslate"><span class="pre">density_sketch.merge()</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.n"><code class="docutils literal notranslate"><span class="pre">density_sketch.n</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.num_retained"><code class="docutils literal notranslate"><span class="pre">density_sketch.num_retained</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">density_sketch.serialize</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">density_sketch.to_string</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.update"><code class="docutils literal notranslate"><span class="pre">density_sketch.update</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.serialize"><code class="docutils literal notranslate"><span class="pre">density_sketch.serialize()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">density_sketch.to_string()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#datasketches.density_sketch.update"><code class="docutils literal notranslate"><span class="pre">density_sketch.update()</span></code></a></li> </ul> </li> </ul> @@ -118,7 +118,7 @@ <p>Requires the use of a <a class="reference internal" href="../helper/kernel.html#datasketches.KernelFunction" title="datasketches.KernelFunction"><code class="xref py py-class docutils literal notranslate"><span class="pre">KernelFunction</span></code></a> to compute the distance between two vectors.</p> <dl class="py class"> <dt class="sig sig-object py" id="datasketches.density_sketch"> -<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">density_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.density_sketch" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">density_sketch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.density_sketch" title="Link to this definition"></a></dt> <dd><p class="rubric">Static Methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="datasketches.density_sketch.deserialize"> @@ -144,67 +144,67 @@ <dl class="py property"> <dt class="sig sig-object py" id="datasketches.density_sketch.dim"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dim</span></span><a class="headerlink" href="#datasketches.density_sketch.dim" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">dim</span></span><a class="headerlink" href="#datasketches.density_sketch.dim" title="Link to this definition"></a></dt> <dd><p>The configured parameter dim</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.density_sketch.get_estimate"> -<span class="sig-name descname"><span class="pre">get_estimate</span></span><a class="headerlink" href="#datasketches.density_sketch.get_estimate" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">point</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.density_sketch.get_estimate" title="Link to this definition"></a></dt> <dd><p>Returns an approximate density at the given point</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.density_sketch.is_empty"> -<span class="sig-name descname"><span class="pre">is_empty</span></span><a class="headerlink" href="#datasketches.density_sketch.is_empty" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.density_sketch.is_empty" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is empty, otherwise False</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.density_sketch.is_estimation_mode"> -<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><a class="headerlink" href="#datasketches.density_sketch.is_estimation_mode" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">is_estimation_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.density_sketch.is_estimation_mode" title="Link to this definition"></a></dt> <dd><p>Returns True if the sketch is in estimation mode, otherwise False</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.density_sketch.k"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.density_sketch.k" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">k</span></span><a class="headerlink" href="#datasketches.density_sketch.k" title="Link to this definition"></a></dt> <dd><p>The configured parameter k</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.density_sketch.merge"> -<span class="sig-name descname"><span class="pre">merge</span></span><a class="headerlink" href="#datasketches.density_sketch.merge" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sketch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.density_sketch" title="_datasketches.density_sketch"><span class="pre">_datasketches.density_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.density_sketch.merge" title="Link to this definition"></a></dt> <dd><p>Merges the provided sketch into this one</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.density_sketch.n"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.density_sketch.n" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">n</span></span><a class="headerlink" href="#datasketches.density_sketch.n" title="Link to this definition"></a></dt> <dd><p>The length of the input stream</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="datasketches.density_sketch.num_retained"> -<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.density_sketch.num_retained" title="Link to this definition"></a></dt> +<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">num_retained</span></span><a class="headerlink" href="#datasketches.density_sketch.num_retained" title="Link to this definition"></a></dt> <dd><p>The number of retained items (samples) in the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.density_sketch.serialize"> -<span class="sig-name descname"><span class="pre">serialize</span></span><a class="headerlink" href="#datasketches.density_sketch.serialize" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">serialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.density_sketch.serialize" title="Link to this definition"></a></dt> <dd><p>Serializes the sketch into a bytes object</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.density_sketch.to_string"> -<span class="sig-name descname"><span class="pre">to_string</span></span><a class="headerlink" href="#datasketches.density_sketch.to_string" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_levels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">print_items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.density_sketch.to_string" title="Link to this definition"></a></dt> <dd><p>Produces a string summary of the sketch</p> </dd></dl> -<dl class="py attribute"> +<dl class="py method"> <dt class="sig sig-object py" id="datasketches.density_sketch.update"> -<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#datasketches.density_sketch.update" title="Link to this definition"></a></dt> +<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.density_sketch.update" title="Link to this definition"></a></dt> <dd><p>Updates the sketch with the given vector</p> </dd></dl>
diff --git a/docs/main/vector/index.html b/docs/main/vector/index.html index 56c6d44..f72d4f5 100644 --- a/docs/main/vector/index.html +++ b/docs/main/vector/index.html
@@ -8,14 +8,14 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Vector Sketches — datasketches 0.1 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> - <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> <script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=2709fde1"></script> - <script src="../_static/doctools.js?v=9bcbadda"></script> - <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/doctools.js?v=fd6eb6e6"></script> + <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" />