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

188 lines
21 KiB
HTML
Raw Normal View History

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Bin</title>
<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="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="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" async="async"></script>
</head>
<body>
<div id="container">
<div id="leftColumn">
<div id="logo"></div>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<script type="text/javascript" src="../../../scripts/pages.js"></script>
<script type="text/javascript" src="../../../scripts/main.js"></script>
<div class="main-content" id="content" pageIds="space.kscience.kmath.histogram/Bin///PointingToDeclaration//587789671">
<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">Bin</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:dokkaHtml/commonMain">common</button><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":kmath-histograms:dokkaHtml/jvmMain">jvm</button></div>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Bin</span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtml/commonMain"><div class="symbol monospace">interface <a href="index.html">Bin</a>&lt;<a href="index.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>&gt; : <span data-unresolved-link="space.kscience.kmath.domains/Domain///PointingToDeclaration/">Domain</span>&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><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="Inheritors">Inheritors</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="%5Bspace.kscience.kmath.domains%2FDomain%2Fcontains%2F%23space.kscience.kmath.structures.Buffer%5BTypeParam%28bounds%3D%5Bkotlin.Any%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671" anchor-label="contains" id="%5Bspace.kscience.kmath.domains%2FDomain%2Fcontains%2F%23space.kscience.kmath.structures.Buffer%5BTypeParam%28bounds%3D%5Bkotlin.Any%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="index.html#%5Bspace.kscience.kmath.domains%2FDomain%2Fcontains%2F%23space.kscience.kmath.structures.Buffer%5BTypeParam%28bounds%3D%5Bkotlin.Any%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671">contains</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.domains%2FDomain%2Fcontains%2F%23space.kscience.kmath.structures.Buffer%5BTypeParam%28bounds%3D%5Bkotlin.Any%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671"></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:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/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:dokkaHtml/commonMain"><div class="symbol monospace">abstract operator fun <a href="index.html#%5Bspace.kscience.kmath.domains%2FDomain%2Fcontains%2F%23space.kscience.kmath.structures.Buffer%5BTypeParam%28bounds%3D%5Bkotlin.Any%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671">contains</a>(point: <span data-unresolved-link="space.kscience.kmath.linear/Point///PointingToDeclaration/">Point</span>&lt;<a href="index.html">T</a>&gt;): <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>
</div>
<a data-name="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671" anchor-label="equals" id="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="../-real-histogram-space/-companion/index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671">equals</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671"></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:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/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:dokkaHtml/commonMain"><div class="symbol monospace">open operator fun <a href="../-real-histogram-space/-companion/index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?): <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>
</div>
<a data-name="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671" anchor-label="hashCode" id="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="../-real-histogram-space/-companion/index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671">hashCode</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671"></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:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/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:dokkaHtml/commonMain"><div class="symbol monospace">open fun <a href="../-real-histogram-space/-companion/index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671">hashCode</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></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671" anchor-label="toString" id="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="../-real-histogram-space/-companion/index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671">toString</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671"></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:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/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:dokkaHtml/commonMain"><div class="symbol monospace">open fun <a href="../-real-histogram-space/-companion/index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F587789671">toString</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</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>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="%5Bspace.kscience.kmath.histogram%2FBin%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" anchor-label="dimension" id="%5Bspace.kscience.kmath.histogram%2FBin%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="index.html#%5Bspace.kscience.kmath.histogram%2FBin%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671">dimension</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.histogram%2FBin%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671"></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:dokkaHtml/commonMain"><a data-name="%5Bspace.kscience.kmath.histogram%2FBin%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" anchor-label="dimension" id="%5Bspace.kscience.kmath.histogram%2FBin%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a><div class="symbol monospace">abstract val <a href="index.html#%5Bspace.kscience.kmath.histogram%2FBin%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671">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></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bspace.kscience.kmath.histogram%2FBin%2Fvalue%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" anchor-label="value" id="%5Bspace.kscience.kmath.histogram%2FBin%2Fvalue%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="value.html">value</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.histogram%2FBin%2Fvalue%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671"></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:dokkaHtml/commonMain"><a data-name="%5Bspace.kscience.kmath.histogram%2FBin%2Fvalue%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" anchor-label="value" id="%5Bspace.kscience.kmath.histogram%2FBin%2Fvalue%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a><div class="symbol monospace">abstract val <a href="value.html">value</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</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="%5Bspace.kscience.kmath.histogram%2FBin%2Fvalue%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" anchor-label="value" id="%5Bspace.kscience.kmath.histogram%2FBin%2Fvalue%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a>The value of this bin.</div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Inheritors</h2>
<div class="table" data-togglable="Inheritors"><a data-name="%5Bspace.kscience.kmath.histogram%2FDomainBin%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F587789671" anchor-label="DomainBin" id="%5Bspace.kscience.kmath.histogram%2FDomainBin%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F587789671" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtml/commonMain" data-filterable-set=":kmath-histograms:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="../-domain-bin/index.html">DomainBin</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.histogram%2FDomainBin%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F587789671"></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="%5Bspace.kscience.kmath.histogram%2FUnivariateBin%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F1270803493" anchor-label="UnivariateBin" id="%5Bspace.kscience.kmath.histogram%2FUnivariateBin%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F1270803493" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":kmath-histograms:dokkaHtml/jvmMain" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="../-univariate-bin/index.html">UnivariateBin</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.histogram%2FUnivariateBin%2F%2F%2FPointingToDeclaration%2F%5D%2FInheritors%2F1270803493"></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>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"></span></a></span></div>
</div>
</div>
</body>
</html>