forked from kscience/kmath
141 lines
16 KiB
HTML
141 lines
16 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>Bin</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/Bin///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">Bin</a></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>Bin</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">interface </span><a href="index.html">Bin</a><span class="token operator"><</span><span class="token keyword">in </span><a href="index.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="index.html">V</a><span class="token operator">></span> : <a href="../../../kmath-core/space.kscience.kmath.domains/-domain/index.html">Domain</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><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><p class="paragraph">The binned data element. Could be a histogram bin with a number of counts or an artificial construct.</p></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><button class="section-tab" data-togglable="Inheritors">Inheritors</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="-154628634%2FFunctions%2F1881323594" anchor-label="contains" id="-154628634%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="index.html#-154628634%2FFunctions%2F1881323594"><span><span>contains</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-154628634%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">abstract </span><span class="token keyword">operator </span><span class="token keyword">fun </span><a href="index.html#-154628634%2FFunctions%2F1881323594"><span class="token function">contains</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"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</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> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Properties</h2>
|
|
<div class="table" data-togglable="Properties"><a data-name="1294598680%2FProperties%2F1881323594" anchor-label="binValue" id="1294598680%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="bin-value.html">binValue</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1294598680%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="1294598680%2FProperties%2F1881323594" anchor-label="binValue" id="1294598680%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="bin-value.html">binValue</a><span class="token operator">: </span><a href="index.html">V</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="1294598680%2FProperties%2F1881323594" anchor-label="binValue" id="1294598680%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><p class="paragraph">The value of this bin.</p></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="2034547098%2FProperties%2F1881323594" anchor-label="dimension" id="2034547098%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="../-domain-bin/index.html#2034547098%2FProperties%2F1881323594">dimension</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2034547098%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="2034547098%2FProperties%2F1881323594" anchor-label="dimension" id="2034547098%2FProperties%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="../-domain-bin/index.html#2034547098%2FProperties%2F1881323594">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> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Inheritors</h2>
|
|
<div class="table" data-togglable="Inheritors"><a data-name="-1608911295%2FInheritors%2F1881323594" anchor-label="DomainBin" id="-1608911295%2FInheritors%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="../-domain-bin/index.html">DomainBin</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1608911295%2FInheritors%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>
|
|
<a data-name="2140320714%2FInheritors%2F1881323594" anchor-label="Bin1D" id="2140320714%2FInheritors%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="../-bin1-d/index.html">Bin1D</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2140320714%2FInheritors%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>
|
|
<h2 class="">Sources</h2>
|
|
<div class="table" data-togglable="Sources"><a data-name="2003211677%2FSource%2F1881323594" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-histograms/src/commonMain/kotlin/space/kscience/kmath/histogram/Histogram.kt#L13" id="2003211677%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/Histogram.kt#L13">common source</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2003211677%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>
|
|
|
|
|