forked from kscience/kmath
139 lines
24 KiB
HTML
139 lines
24 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>Companion</title>
|
|
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode")
|
|
if (storage == null) {
|
|
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
|
if (osDarkSchemePreferred === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
} else {
|
|
const savedDarkMode = JSON.parse(storage)
|
|
if(savedDarkMode === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
}
|
|
</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 type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
|
|
<body>
|
|
<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>0.3.1-dev-RC
|
|
</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>
|
|
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":kmath-histograms:dokkaHtmlPartial/jvmMain">jvm</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" data-page-type="classlike" id="content" pageids="kmath-histograms::space.kscience.kmath.histogram/Histogram.Companion///PointingToDeclaration//1881323594">
|
|
<div class="breadcrumbs"><a href="../../../index.html">kmath-histograms</a><span class="delimiter">/</span><a href="../../index.html">space.kscience.kmath.histogram</a><span class="delimiter">/</span><a href="../index.html">Histogram</a><span class="delimiter">/</span><span class="current">Companion</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>Companion</span></span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-histograms/src/commonMain/kotlin/space/kscience/kmath/histogram/Histogram.kt#L45">source</a>)</span></span></div></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members & Extensions</button></div>
|
|
<div class="tabs-section-body">
|
|
<div data-togglable="EXTENSION_FUNCTION">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table"><a data-name="1730787298%2FFunctions%2F-1345501332" anchor-label="custom1D" id="1730787298%2FFunctions%2F-1345501332" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/jvmMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/jvmMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../custom1-d.html"><span><span>custom1D</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1730787298%2FFunctions%2F-1345501332"></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" data-filterable-current=":kmath-histograms:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/jvmMain" data-active="" data-toggle=":kmath-histograms:dokkaHtmlPartial/jvmMain">jvm</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../../custom1-d.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 punctuation">, </span><span class="token keyword"></span><a href="../../custom1-d.html">A</a><span class="token operator"> : </span><a href="../../../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../custom1-d.html">V</a><span class="token operator">></span>, <a href="../../../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../custom1-d.html">V</a><span class="token operator">></span><span class="token operator">> </span><a href="index.html#-878027230%2FMain%2F-1345501332">Histogram.Companion</a><span class="token punctuation">.</span><a href="../../custom1-d.html"><span class="token function">custom1D</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">valueAlgebra<span class="token operator">: </span><a href="../../custom1-d.html">A</a><span class="token punctuation">, </span></span><span class="parameter ">borders<span class="token operator">: </span><a href="../../../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-tree-histogram-group/index.html">TreeHistogramGroup</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../custom1-d.html">V</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../custom1-d.html">A</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Create a histogram group with custom cell borders</p></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1737084920%2FFunctions%2F1881323594" anchor-label="uniform1D" id="-1737084920%2FFunctions%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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="../../uniform1-d.html"><span><span>uniform1D</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1737084920%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 " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-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"><</span><span class="token keyword"></span><a href="../../uniform1-d.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 punctuation">, </span><span class="token keyword"></span><a href="../../uniform1-d.html">A</a><span class="token operator"> : </span><a href="../../../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform1-d.html">V</a><span class="token operator">></span>, <a href="../../../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform1-d.html">V</a><span class="token operator">></span><span class="token operator">> </span><a href="index.html">Histogram.Companion</a><span class="token punctuation">.</span><a href="../../uniform1-d.html"><span class="token function">uniform1D</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">valueAlgebra<span class="token operator">: </span><a href="../../uniform1-d.html">A</a><span class="token punctuation">, </span></span><span class="parameter ">binSize<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span></span><span class="parameter ">startPoint<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator"> = </span><span class="token constant">0.0</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-uniform-histogram1-d-group/index.html">UniformHistogram1DGroup</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform1-d.html">V</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../uniform1-d.html">A</a><span class="token operator">></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="441358801%2FFunctions%2F1881323594" anchor-label="uniformDoubleNDFromRanges" id="441358801%2FFunctions%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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="../../uniform-double-n-d-from-ranges.html"><span>uniform</span><wbr><span>Double</span><wbr><span>NDFrom</span><wbr><span><span>Ranges</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="441358801%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 " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-histograms:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html">Histogram.Companion</a><span class="token punctuation">.</span><a href="../../uniform-double-n-d-from-ranges.html"><span class="token function">uniformDoubleNDFromRanges</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>ranges<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-floating-point-range/index.html">ClosedFloatingPointRange</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-uniform-histogram-group-n-d/index.html">UniformHistogramGroupND</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../../../kmath-core/space.kscience.kmath.operations/-double-field/index.html">DoubleField</a><span class="token operator">></span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html">Histogram.Companion</a><span class="token punctuation">.</span><a href="../../uniform-double-n-d-from-ranges.html"><span class="token function">uniformDoubleNDFromRanges</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>ranges<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-floating-point-range/index.html">ClosedFloatingPointRange</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-uniform-histogram-group-n-d/index.html">UniformHistogramGroupND</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../../../kmath-core/space.kscience.kmath.operations/-double-field/index.html">DoubleField</a><span class="token operator">></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-15110161%2FFunctions%2F1881323594" anchor-label="uniformNDFromRanges" id="-15110161%2FFunctions%2F1881323594" data-filterable-set=":kmath-histograms:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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="../../uniform-n-d-from-ranges.html"><span>uniform</span><wbr><span>NDFrom</span><wbr><span><span>Ranges</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-15110161%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 " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-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"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.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 punctuation">, </span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">A</a><span class="token operator"> : </span><a href="../../../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">V</a><span class="token operator">></span><span class="token operator">> </span><a href="index.html">Histogram.Companion</a><span class="token punctuation">.</span><a href="../../uniform-n-d-from-ranges.html"><span class="token function">uniformNDFromRanges</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">valueAlgebraND<span class="token operator">: </span><a href="../../../../kmath-core/space.kscience.kmath.nd/-field-ops-n-d/index.html">FieldOpsND</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">V</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">A</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">vararg </span>ranges<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-floating-point-range/index.html">ClosedFloatingPointRange</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">bufferFactory<span class="token operator">: </span><a href="../../../../kmath-core/space.kscience.kmath.structures/-buffer-factory/index.html">BufferFactory</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">V</a><span class="token operator">></span><span class="token operator"> = </span>valueAlgebraND.elementAlgebra.bufferFactory</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-uniform-histogram-group-n-d/index.html">UniformHistogramGroupND</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">V</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">A</a><span class="token operator">></span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.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 punctuation">, </span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">A</a><span class="token operator"> : </span><a href="../../../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">V</a><span class="token operator">></span><span class="token operator">> </span><a href="index.html">Histogram.Companion</a><span class="token punctuation">.</span><a href="../../uniform-n-d-from-ranges.html"><span class="token function">uniformNDFromRanges</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">valueAlgebraND<span class="token operator">: </span><a href="../../../../kmath-core/space.kscience.kmath.nd/-field-ops-n-d/index.html">FieldOpsND</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">V</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">A</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">vararg </span>ranges<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-floating-point-range/index.html">ClosedFloatingPointRange</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">bufferFactory<span class="token operator">: </span><a href="../../../../kmath-core/space.kscience.kmath.structures/-buffer-factory/index.html">BufferFactory</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">V</a><span class="token operator">></span><span class="token operator"> = </span>valueAlgebraND.elementAlgebra.bufferFactory</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-uniform-histogram-group-n-d/index.html">UniformHistogramGroupND</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">V</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../uniform-n-d-from-ranges.html">A</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Use it like</p></div></div></div>
|
|
</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>© 2023 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>
|
|
|