kmath/kmath-core/space.kscience.kmath.data/index.html

188 lines
25 KiB
HTML
Raw Normal View History

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.kmath.data</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-core: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" data-page-type="package" id="content" pageids="kmath-core::space.kscience.kmath.data////PointingToDeclaration//244675578">
<div class="breadcrumbs"><a href="../index.html">kmath-core</a><span class="delimiter">/</span><span class="current">space.kscience.kmath.data</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button><button class="section-tab" data-togglable="PROPERTY,EXTENSION_PROPERTY">Properties</button></div>
<div class="tabs-section-body">
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="-1034044445%2FClasslikes%2F244675578" anchor-label="ColumnarData" id="-1034044445%2FClasslikes%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-columnar-data/index.html"><span>Columnar</span><wbr><span><span>Data</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1034044445%2FClasslikes%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></div></div><span class="token keyword">interface </span><a href="-columnar-data/index.html">ColumnarData</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="-columnar-data/index.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">A column-based data set with all columns of the same size (not necessary fixed in time). The column could be retrieved by a <a href="-columnar-data/get.html">get</a> operation.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="353007810%2FClasslikes%2F244675578" anchor-label="XYColumnarData" id="353007810%2FClasslikes%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-x-y-columnar-data/index.html"><span>XYColumnar</span><wbr><span><span>Data</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="353007810%2FClasslikes%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></div></div><span class="token keyword">interface </span><a href="-x-y-columnar-data/index.html">XYColumnarData</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="-x-y-columnar-data/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-x-y-columnar-data/index.html">X</a><span class="token operator"> : </span><a href="-x-y-columnar-data/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-x-y-columnar-data/index.html">Y</a><span class="token operator"> : </span><a href="-x-y-columnar-data/index.html">T</a><span class="token operator">&gt;</span> : <a href="-columnar-data/index.html">ColumnarData</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-x-y-columnar-data/index.html">T</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">The buffer of X values.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1838736726%2FClasslikes%2F244675578" anchor-label="XYErrorColumnarData" id="1838736726%2FClasslikes%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-x-y-error-columnar-data/index.html"><span>XYError</span><wbr><span>Columnar</span><wbr><span><span>Data</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1838736726%2FClasslikes%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></div></div><span class="token keyword">interface </span><a href="-x-y-error-columnar-data/index.html">XYErrorColumnarData</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-x-y-error-columnar-data/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-x-y-error-columnar-data/index.html">X</a><span class="token operator"> : </span><a href="-x-y-error-columnar-data/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-x-y-error-columnar-data/index.html">Y</a><span class="token operator"> : </span><a href="-x-y-error-columnar-data/index.html">T</a><span class="token operator">&gt;</span> : <a href="-x-y-columnar-data/index.html">XYColumnarData</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-x-y-error-columnar-data/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-x-y-error-columnar-data/index.html">X</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-x-y-error-columnar-data/index.html">Y</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">A <a href="-columnar-data/index.html">ColumnarData</a> with additional <a href="../space.kscience.kmath.expressions/-symbol/-companion/y-error.html">Symbol.yError</a> column for an <a href="../space.kscience.kmath.expressions/-symbol/-companion/y.html">Symbol.y</a> error Inherits <a href="-x-y-columnar-data/index.html">XYColumnarData</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1199088932%2FClasslikes%2F244675578" anchor-label="XYZColumnarData" id="1199088932%2FClasslikes%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-x-y-z-columnar-data/index.html"><span>XYZColumnar</span><wbr><span><span>Data</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1199088932%2FClasslikes%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></div></div><span class="token keyword">interface </span><a href="-x-y-z-columnar-data/index.html">XYZColumnarData</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="-x-y-z-columnar-data/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-x-y-z-columnar-data/index.html">X</a><span class="token operator"> : </span><a href="-x-y-z-columnar-data/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-x-y-z-columnar-data/index.html">Y</a><span class="token operator"> : </span><a href="-x-y-z-columnar-data/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-x-y-z-columnar-data/index.html">Z</a><span class="token operator"> : </span><a href="-x-y-z-columnar-data/index.html">T</a><span class="token operator">&gt;</span> : <a href="-x-y-columnar-data/index.html">XYColumnarData</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-x-y-z-columnar-data/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-x-y-z-columnar-data/index.html">X</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-x-y-z-columnar-data/index.html">Y</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">A <a href="-columnar-data/index.html">ColumnarData</a> with guaranteed <a href="../../kmath-core/space.kscience.kmath.data/-x-y-z-columnar-data/x.html">x</a>, <a href="../../kmath-core/space.kscience.kmath.data/-x-y-z-columnar-data/y.html">y</a> and <a href="-x-y-z-columnar-data/z.html">z</a> columns designated by corresponding symbols. Inherits <a href="-x-y-columnar-data/index.html">XYColumnarData</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="EXTENSION_FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="-736290806%2FFunctions%2F244675578" anchor-label="asColumnarData" id="-736290806%2FFunctions%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="as-columnar-data.html"><span>as</span><wbr><span>Columnar</span><wbr><span><span>Data</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-736290806%2FFunctions%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-columnar-data.html">T</a><span class="token operator">&gt; </span><a href="../space.kscience.kmath.nd/-structure2-d/index.html">Structure2D</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-columnar-data.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="as-columnar-data.html"><span class="token function">asColumnarData</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">mapping<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../space.kscience.kmath.expressions/-symbol/index.html">Symbol</a><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">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-columnar-data/index.html">ColumnarData</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-columnar-data.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">A zero-copy method to represent a <a href="../space.kscience.kmath.nd/-structure2-d/index.html">Structure2D</a> as a two-column x-y data. There could more than two columns in the structure.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1835893548%2FFunctions%2F244675578" anchor-label="asXYData" id="-1835893548%2FFunctions%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="as-x-y-data.html"><span>as</span><wbr><span><span>XYData</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1835893548%2FFunctions%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token operator">&gt; </span><a href="-columnar-data/index.html">ColumnarData</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="as-x-y-data.html"><span class="token function">asXYData</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">xSymbol<span class="token operator">: </span><a href="../space.kscience.kmath.expressions/-symbol/index.html">Symbol</a><span class="token punctuation">, </span></span><span class="parameter ">ySymbol<span class="token operator">: </span><a href="../space.kscience.kmath.expressions/-symbol/index.html">Symbol</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-x-y-columnar-data/index.html">XYColumnarData</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Represent a <a href="-columnar-data/index.html">ColumnarData</a> as an <a href="-x-y-columnar-data/index.html">XYColumnarData</a>. The presence or respective columns is checked on creation.</p></div><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token operator">&gt; </span><a href="../space.kscience.kmath.nd/-structure2-d/index.html">Structure2D</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="as-x-y-data.html"><span class="token function">asXYData</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">xIndex<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">0</span><span class="token punctuation">, </span></span><span class="parameter ">yIndex<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">1</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-x-y-columnar-data/index.html">XYColumnarData</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="as-x-y-data.html">T</a><span class="token op
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="EXTENSION_PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="1325032725%2FProperties%2F244675578" anchor-label="indices" id="1325032725%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="indices.html"><span><span>indices</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1325032725%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">val </span><a href="-columnar-data/index.html">ColumnarData</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="indices.html">indices</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-int-range/index.html">IntRange</a></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>