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

190 lines
23 KiB
HTML
Raw Normal View History

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TreeHistogram</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/TreeHistogram///PointingToDeclaration//1270803493">
<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">TreeHistogram</a></div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section"><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>Tree</span><wbr></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:dokkaHtml/jvmMain"><div class="symbol monospace">class <a href="index.html">TreeHistogram</a>(context: <a href="../-tree-histogram-space/index.html">TreeHistogramSpace</a>, binMap: <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TreeMap.html">TreeMap</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>, out <a href="../-univariate-bin/index.html">UnivariateBin</a>&gt;) : <a href="../-univariate-histogram/index.html">UnivariateHistogram</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 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></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493" anchor-label="equals" id="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%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-histogram-builder/index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493">equals</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%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 class="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-histograms:dokkaHtml/jvmMain" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"><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/jvmMain"><div class="symbol monospace">open operator fun <a href="../-univariate-histogram-builder/index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493">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="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fget%2F%23kotlin.Double%2FPointingToDeclaration%2F%2C+space.kscience.kmath.histogram%2FUnivariateHistogram%2Fget%2F%23space.kscience.kmath.structures.Buffer%5Bkotlin.Double%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493" anchor-label="get" id="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fget%2F%23kotlin.Double%2FPointingToDeclaration%2F%2C+space.kscience.kmath.histogram%2FUnivariateHistogram%2Fget%2F%23space.kscience.kmath.structures.Buffer%5Bkotlin.Double%5D%2FPointingToDeclaration%2F%5D%2FFunctions%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="get.html">get</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fget%2F%23kotlin.Double%2FPointingToDeclaration%2F%2C+space.kscience.kmath.histogram%2FUnivariateHistogram%2Fget%2F%23space.kscience.kmath.structures.Buffer%5Bkotlin.Double%5D%2FPointingToDeclaration%2F%5D%2FFunctions%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 class="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-histograms:dokkaHtml/jvmMain" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"><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/jvmMain"><div class="symbol monospace">open operator override fun <a href="get.html">get</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>): <a href="../-univariate-bin/index.html">UnivariateBin</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 class="divergent-group" data-filterable-current=":kmath-histograms:dokkaHtml/jvmMain" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"><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/jvmMain"><div class="symbol monospace">open operator override fun <a href="../-univariate-histogram/get.html">get</a>(point: <span data-unresolved-link="space.kscience.kmath.structures/Buffer///PointingToDeclaration/">Buffer</span>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>&gt;): <a href="../-univariate-bin/index.html">UnivariateBin</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>
<a data-name="%5Bspace.kscience.kmath.histogram%2FUnivariateHistogram%2Fget%2F%23space.kscience.kmath.structures.Buffer%5Bkotlin.Double%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493" anchor-label="get" id="%5Bspace.kscience.kmath.histogram%2FUnivariateHistogram%2Fget%2F%23space.kscience.kmath.structures.Buffer%5Bkotlin.Double%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"></a><div class="brief "><a data-name="%5Bspace.kscience.kmath.histogram%2FUnivariateHistogram%2Fget%2F%23space.kscience.kmath.structures.Buffer%5Bkotlin.Double%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493" anchor-label="get" id="%5Bspace.kscience.kmath.histogram%2FUnivariateHistogram%2Fget%2F%23space.kscience.kmath.structures.Buffer%5Bkotlin.Double%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"></a>Find existing bin, corresponding to given coordinates</div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493" anchor-label="hashCode" id="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%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-histogram-builder/index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493">hashCode</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%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 class="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-histograms:dokkaHtml/jvmMain" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"><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/jvmMain"><div class="symbol monospace">open fun <a href="../-univariate-histogram-builder/index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493">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%2F1270803493" anchor-label="toString" id="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%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-histogram-builder/index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493">toString</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%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 class="platform-tags ">
<div class="platform-tag jvm-like">jvm</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":kmath-histograms:dokkaHtml/jvmMain" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"><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/jvmMain"><div class="symbol monospace">open fun <a href="../-univariate-histogram-builder/index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F1270803493">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%2FTreeHistogram%2Fbins%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" anchor-label="bins" id="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fbins%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%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="bins.html">bins</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fbins%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%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 class="platform-tags ">
<div class="platform-tag jvm-like">jvm</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/jvmMain"><a data-name="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fbins%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" anchor-label="bins" id="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fbins%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"></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/-collection/index.html">Collection</a>&lt;<a href="../-univariate-bin/index.html">UnivariateBin</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="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fcontext%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" anchor-label="context" id="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fcontext%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%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="context.html">context</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fcontext%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%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 class="platform-tags ">
<div class="platform-tag jvm-like">jvm</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/jvmMain"><a data-name="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fcontext%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" anchor-label="context" id="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fcontext%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"></a><div class="symbol monospace">open override val <a href="context.html">context</a>: <a href="../-tree-histogram-space/index.html">TreeHistogramSpace</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%2FTreeHistogram%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" anchor-label="dimension" id="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%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="dimension.html">dimension</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%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 class="platform-tags ">
<div class="platform-tag jvm-like">jvm</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/jvmMain"><a data-name="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" anchor-label="dimension" id="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"></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="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" anchor-label="dimension" id="%5Bspace.kscience.kmath.histogram%2FTreeHistogram%2Fdimension%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F1270803493" data-filterable-set=":kmath-histograms:dokkaHtml/jvmMain"></a>Dimension of the histogram</div></div></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>