2023-04-09 11:31:42 +03:00
|
|
|
<!doctype html>
|
2021-05-08 18:18:11 +03:00
|
|
|
<html>
|
2023-04-09 11:31:42 +03:00
|
|
|
<head>
|
2021-05-08 18:18:11 +03:00
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
|
|
|
<title>Companion</title>
|
2023-04-09 11:31:42 +03:00
|
|
|
<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>
|
2022-04-12 11:30:54 +03:00
|
|
|
<div id="searchBar"></div>
|
|
|
|
|
</div>
|
2023-04-09 11:31:42 +03:00
|
|
|
</div>
|
|
|
|
|
<div id="container">
|
|
|
|
|
<div id="leftColumn">
|
2021-05-08 18:18:11 +03:00
|
|
|
<div id="sideMenu"></div>
|
2023-04-09 11:31:42 +03:00
|
|
|
</div>
|
|
|
|
|
<div id="main">
|
|
|
|
|
<div class="main-content" data-page-type="classlike" id="content" pageids="kmath-core::space.kscience.kmath.nd/StructureND.Companion///PointingToDeclaration//244675578">
|
|
|
|
|
<div class="breadcrumbs"><a href="../../../index.html">kmath-core</a><span class="delimiter">/</span><a href="../../index.html">space.kscience.kmath.nd</a><span class="delimiter">/</span><a href="../index.html">StructureND</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-core: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-core/src/commonMain/kotlin/space/kscience/kmath/nd/StructureND.kt#L66">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">Members</button></div>
|
|
|
|
|
<div class="tabs-section-body">
|
|
|
|
|
<div data-togglable="FUNCTION">
|
|
|
|
|
<h2 class="">Functions</h2>
|
|
|
|
|
<div class="table"><a data-name="1535817209%2FFunctions%2F244675578" anchor-label="auto" id="1535817209%2FFunctions%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="auto.html"><span><span>auto</span></span></a></div>
|
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1535817209%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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation builtin">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"autoVarArg"</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="auto.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 operator">> </span><a href="auto.html"><span class="token function">auto</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>shape<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">crossinline </span>initializer<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-array/index.html">IntArray</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="auto.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-buffer-n-d/index.html">BufferND</a><span class="token operator"><</span><span class="token keyword"></span><a href="auto.html">T</a><span class="token operator">></span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="auto.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 operator">> </span><a href="auto.html"><span class="token function">auto</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">shape<span class="token operator">: </span><a href="../../-shape-n-d/index.html">ShapeND</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">crossinline </span>initializer<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-array/index.html">IntArray</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="auto.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-buffer-n-d/index.html">BufferND</a><span class="token operator"><</span><span class="token keyword"></span><a href="auto.html">T</a><span class="token operator">></span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="auto.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 operator">> </span><a href="auto.html"><span class="token function">auto</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="to
|
2021-05-08 18:18:11 +03:00
|
|
|
</div>
|
2023-04-09 11:31:42 +03:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<a data-name="-428577649%2FFunctions%2F244675578" anchor-label="buffered" id="-428577649%2FFunctions%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="buffered.html"><span><span>buffered</span></span></a></div>
|
|
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-428577649%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"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="buffered.html">T</a><span class="token operator">> </span><a href="buffered.html"><span class="token function">buffered</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">shape<span class="token operator">: </span><a href="../../-shape-n-d/index.html">ShapeND</a><span class="token punctuation">, </span></span><span class="parameter ">bufferFactory<span class="token operator">: </span><a href="../../../space.kscience.kmath.structures/-buffer-factory/index.html">BufferFactory</a><span class="token operator"><</span><span class="token keyword"></span><a href="buffered.html">T</a><span class="token operator">></span><span class="token operator"> = </span>BufferFactory.boxing()<span class="token punctuation">, </span></span><span class="parameter ">initializer<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-array/index.html">IntArray</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="buffered.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-buffer-n-d/index.html">BufferND</a><span class="token operator"><</span><span class="token keyword"></span><a href="buffered.html">T</a><span class="token operator">></span></div><br><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="buffered.html">T</a><span class="token operator">> </span><a href="buffered.html"><span class="token function">buffered</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">strides<span class="token operator">: </span><a href="../../-strides/index.html">Strides</a><span class="token punctuation">, </span></span><span class="parameter ">bufferFactory<span class="token operator">: </span><a href="../../../space.kscience.kmath.structures/-buffer-factory/index.html">BufferFactory</a><span class="token operator"><</span><span class="token keyword"></span><a href="buffered.html">T</a><span class="token operator">></span><span class="token operator"> = </span>BufferFactory.boxing()<span class="token punctuation">, </span></span><span class="parameter ">initializer<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-array/index.html">IntArray</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="buffered.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-buffer-n-d/index.html">BufferND</a><span class="token operator"><</span><span class="token keyword"></span><a href="buffered.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Creates a NDStructure with explicit buffer factory.</p></div></div></div>
|
2021-05-08 18:18:11 +03:00
|
|
|
</div>
|
2023-04-09 11:31:42 +03:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2021-10-13 15:08:46 +03:00
|
|
|
<a data-name="786449179%2FFunctions%2F244675578" anchor-label="contentEquals" id="786449179%2FFunctions%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
2023-04-09 11:31:42 +03:00
|
|
|
<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="content-equals.html"><span>content</span><wbr><span><span>Equals</span></span></a></div>
|
2022-04-12 11:30:54 +03:00
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="786449179%2FFunctions%2F244675578"></span>
|
2023-04-09 11:31:42 +03:00
|
|
|
<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/-performance-pitfall/index.html"><span class="token annotation builtin">PerformancePitfall</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="content-equals.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 operator">> </span><a href="content-equals.html"><span class="token function">contentEquals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">st1<span class="token operator">: </span><a href="../index.html">StructureND</a><span class="token operator"><</span><span class="token keyword"></span><a href="content-equals.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">st2<span class="token operator">: </span><a href="../index.html">StructureND</a><span class="token operator"><</span><span class="token keyword"></span><a href="content-equals.html">T</a><span class="token operator">></span></span></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></div><div class="brief "><p class="paragraph">Indicates whether some <a href="../index.html">StructureND</a> is equal to another one.</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/-performance-pitfall/index.html"><span class="token annotation builtin">PerformancePitfall</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="content-equals.html"><span class="token function">contentEquals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">st1<span class="token operator">: </span><a href="../index.html">StructureND</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 ">st2<span class="token operator">: </span><a href="../index.html">StructureND</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 ">tolerance<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">1.0E-11</span></span></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></div></div></div>
|
2021-05-08 18:18:11 +03:00
|
|
|
</div>
|
2023-04-09 11:31:42 +03:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2021-05-08 18:18:11 +03:00
|
|
|
<a data-name="-182276349%2FFunctions%2F244675578" anchor-label="toString" id="-182276349%2FFunctions%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
2023-04-09 11:31:42 +03:00
|
|
|
<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="to-string.html"><span>to</span><wbr><span><span>String</span></span></a></div>
|
2022-04-12 11:30:54 +03:00
|
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-182276349%2FFunctions%2F244675578"></span>
|
2023-04-09 11:31:42 +03:00
|
|
|
<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"><span class="token keyword"></span><span class="token keyword">fun </span><a href="to-string.html"><span class="token function">toString</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">structure<span class="token operator">: </span><a href="../index.html">StructureND</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Debug output to string</p></div></div></div>
|
2021-10-13 15:08:46 +03:00
|
|
|
</div>
|
|
|
|
|
</div>
|
2021-05-08 18:18:11 +03:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2023-04-09 11:31:42 +03:00
|
|
|
</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>
|
2021-05-08 18:18:11 +03:00
|
|
|
|
