teldufalsari/kmath
2
0
Fork 0
forked from kscience/kmath
Code Pull Requests 1 Activity
494f184902
kmath/kmath-histograms/space.kscience.kmath.histogram/-histogram-n-d/index.html

159 lines
25 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ mipt-npm/kmath@b698f2d613cdf20cdfb03cb7185ca7c04318b786 🚀
2022-04-12 11:30:54 +03:00
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>HistogramND</title>
</head><body><link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><link href="../../../styles/prism.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><script type="text/javascript" src="../../../scripts/clipboard.js" async></script><script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script><script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script><script type="text/javascript" src="../../../scripts/main.js" defer></script><script type="text/javascript" src="../../../scripts/prism.js" async></script><script>const storage = localStorage.getItem("dokka-dark-mode")
const savedDarkMode = storage ? JSON.parse(storage) : false
if(savedDarkMode === true){
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}</script>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name"><a href="../../../index.html"><span>kmath</span></a></div>
<div></div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector common-like" data-active="" data-filter=":kmath-histograms:dokkaHtmlPartial/commonMain">common</button></div>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageids="kmath-histograms::space.kscience.kmath.histogram/HistogramND///PointingToDeclaration//1881323594">
<div class="breadcrumbs"><a href="../../index.html">kmath-histograms</a>/<a href="../index.html">space.kscience.kmath.histogram</a>/<a href="index.html">HistogramND</a></div>
<div class="cover ">
<h1 class="cover"><span>Histogram</span><wbr><span><span>ND</span></span></h1>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-histograms:dokkaHtmlPartial/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">HistogramND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">D</a><span class="token operator"> : </span><a href="../../../kmath-core/space.kscience.kmath.domains/-domain/index.html">Domain</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token punctuation">(</span>group<span class="token operator">: </span><a href="../-histogram-group-n-d/index.html">HistogramGroupND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">D</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator">&gt;</span><span class="token punctuation">, </span>values<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator">&gt;</span><span class="token punctuation">)</span> : <a href="../-histogram/index.html">Histogram</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">V</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../-domain-bin/index.html">DomainBin</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">D</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div> </div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button><button class="section-tab" data-togglable="Parameters">Parameters</button><button class="section-tab" data-togglable="Sources">Sources</button></div>
<div class="tabs-section-body">
<h2 class="">Parameters</h2>
<div data-togglable="Parameters">
<div class="platform-hinted WithExtraAttributes with-platform-tabs" data-platform-hinted="data-platform-hinted" data-togglable="Parameters">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-histograms:dokkaHtmlPartial/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>T</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the type of the argument space</p></div></div></div></div></div><div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>V</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the type of bin value</p></div></div></div></div></div></div></div></div> </div>
</div>
<h2 class="tabbedcontent">Constructors</h2>
<div class="table" data-togglable="Constructors"><a data-name="-765316141%2FConstructors%2F1881323594" anchor-label="HistogramND" id="-765316141%2FConstructors%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex">
<div><a href="-histogram-n-d.html"><span>Histogram</span><wbr><span><span>ND</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-765316141%2FConstructors%2F1881323594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-histograms:dokkaHtmlPartial/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">D</a><span class="token operator"> : </span><a href="../../../kmath-core/space.kscience.kmath.domains/-domain/index.html">Domain</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="-histogram-n-d.html"><span class="token function">HistogramND</span></a><span class="token punctuation">(</span>group<span class="token operator">: </span><a href="../-histogram-group-n-d/index.html">HistogramGroupND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">D</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator">&gt;</span><span class="token punctuation">, </span>values<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div> </div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="-36314578%2FFunctions%2F1881323594" anchor-label="get" id="-36314578%2FFunctions%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="get.html"><span><span>get</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-36314578%2FFunctions%2F1881323594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-histograms:dokkaHtmlPartial/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="get.html"><span class="token function">get</span></a><span class="token punctuation">(</span>point<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.linear/-point/index.html">Point</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-domain-bin/index.html">DomainBin</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">D</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator">&gt;</span><span class="token operator">?</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Find existing bin, corresponding to given coordinates</p></div></div> </div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="601946121%2FProperties%2F1881323594" anchor-label="bins" id="601946121%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="bins.html">bins</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="601946121%2FProperties%2F1881323594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted" data-togglable="Properties">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-histograms:dokkaHtmlPartial/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><a data-name="601946121%2FProperties%2F1881323594" anchor-label="bins" id="601946121%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="bins.html">bins</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-domain-bin/index.html">DomainBin</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">D</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="1742788863%2FProperties%2F1881323594" anchor-label="dimension" id="1742788863%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="dimension.html">dimension</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1742788863%2FProperties%2F1881323594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted" data-togglable="Properties">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-histograms:dokkaHtmlPartial/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><a data-name="1742788863%2FProperties%2F1881323594" anchor-label="dimension" id="1742788863%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="dimension.html">dimension</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="1742788863%2FProperties%2F1881323594" anchor-label="dimension" id="1742788863%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><p class="paragraph">Dimension of the histogram</p></div></div> </div>
</div>
</div>
</div>
</div>
<a data-name="-1968258554%2FProperties%2F1881323594" anchor-label="group" id="-1968258554%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="group.html">group</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1968258554%2FProperties%2F1881323594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted" data-togglable="Properties">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-histograms:dokkaHtmlPartial/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><a data-name="-1968258554%2FProperties%2F1881323594" anchor-label="group" id="-1968258554%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="group.html">group</a><span class="token operator">: </span><a href="../-histogram-group-n-d/index.html">HistogramGroupND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">D</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">V</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div> </div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Sources</h2>
<div class="table" data-togglable="Sources"><a data-name="2023577834%2FSource%2F1881323594" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-histograms/src/commonMain/kotlin/space/kscience/kmath/histogram/HistogramND.kt#L18" id="2023577834%2FSource%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="https://github.com/mipt-npm/kmath/tree/master/kmath-histograms/src/commonMain/kotlin/space/kscience/kmath/histogram/HistogramND.kt#L18">common source</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2023577834%2FSource%2F1881323594"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
</div>
</div>
</body></html>
Copy Permalink