kmath/kmath-histograms/space.kscience.kmath.histogram/-indexed-histogram/index.html

141 lines
16 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>IndexedHistogram</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/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.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" async></script>
<div id="container">
<div id="leftColumn"><a href="../../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<script type="text/javascript" src="../../../scripts/main.js"></script><div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="main-content" id="content" pageids="kmath-histograms::space.kscience.kmath.histogram/IndexedHistogram///PointingToDeclaration//1881323594">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">kmath-histograms</a>/<a href="../index.html">space.kscience.kmath.histogram</a>/<a href="index.html">IndexedHistogram</a></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>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Indexed</span><wbr><span>Histogram</span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="symbol monospace">class <a href="index.html">IndexedHistogram</a>&lt;<a href="index.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a>&lt;<a href="index.html">T</a>&gt;, <a href="index.html">V</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>&gt;(context: <a href="../-indexed-histogram-space/index.html">IndexedHistogramSpace</a>&lt;<a href="index.html">T</a>, <a href="index.html">V</a>&gt;, values: <a href="../../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a>&lt;<a href="index.html">V</a>&gt;) : <a href="../-histogram/index.html">Histogram</a>&lt;<a href="index.html">T</a>, <a href="../-bin/index.html">Bin</a>&lt;<a href="index.html">T</a>&gt;&gt; <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="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button><button class="section-tab" data-togglable="Sources">Sources</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="2080382255%2FFunctions%2F1881323594" anchor-label="get" id="2080382255%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"><a href="get.html">get</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2080382255%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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="symbol monospace">open operator override fun <a href="get.html">get</a>(point: <a href="../../../kmath-core/space.kscience.kmath.linear/-point/index.html">Point</a>&lt;<a href="index.html">T</a>&gt;): <a href="../-bin/index.html">Bin</a>&lt;<a href="index.html">T</a>&gt;?<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>
<a data-name="2080382255%2FFunctions%2F1881323594" anchor-label="get" id="2080382255%2FFunctions%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="2080382255%2FFunctions%2F1881323594" anchor-label="get" id="2080382255%2FFunctions%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>Find existing bin, corresponding to given coordinates</div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="880456488%2FProperties%2F1881323594" anchor-label="bins" id="880456488%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"><a href="bins.html">bins</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="880456488%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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><a data-name="880456488%2FProperties%2F1881323594" anchor-label="bins" id="880456488%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace">open override val <a href="bins.html">bins</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a>&lt;<a href="../-bin/index.html">Bin</a>&lt;<a href="index.html">T</a>&gt;&gt;<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="1430068055%2FProperties%2F1881323594" anchor-label="context" id="1430068055%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"><a href="context.html">context</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1430068055%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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><a data-name="1430068055%2FProperties%2F1881323594" anchor-label="context" id="1430068055%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace">val <a href="context.html">context</a>: <a href="../-indexed-histogram-space/index.html">IndexedHistogramSpace</a>&lt;<a href="index.html">T</a>, <a href="index.html">V</a>&gt;<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="503986496%2FProperties%2F1881323594" anchor-label="dimension" id="503986496%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"><a href="dimension.html">dimension</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="503986496%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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><a data-name="503986496%2FProperties%2F1881323594" anchor-label="dimension" id="503986496%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace">open override val <a href="dimension.html">dimension</a>: <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="503986496%2FProperties%2F1881323594" anchor-label="dimension" id="503986496%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>Dimension of the histogram</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1252194990%2FProperties%2F1881323594" anchor-label="values" id="-1252194990%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"><a href="values.html">values</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1252194990%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="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><a data-name="-1252194990%2FProperties%2F1881323594" anchor-label="values" id="-1252194990%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace">val <a href="values.html">values</a>: <a href="../../../kmath-core/space.kscience.kmath.nd/-structure-n-d/index.html">StructureND</a>&lt;<a href="index.html">V</a>&gt;<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="164947563%2FSource%2F1881323594" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-histograms/src/commonMain/kotlin/space/kscience/kmath/histogram/IndexedHistogramSpace.kt#L26" id="164947563%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"><a href="https://github.com/mipt-npm/kmath/tree/master/kmath-histograms/src/commonMain/kotlin/space/kscience/kmath/histogram/IndexedHistogramSpace.kt#L26">common source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="164947563%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"></a></span><span>© 2021 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>