forked from kscience/kmath
157 lines
21 KiB
HTML
157 lines
21 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>Companion</title>
|
|
</head><body><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></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></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" async></script>
|
|
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<script type="text/javascript" src="../../../../scripts/main.js"></script><div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
|
|
<div class="main-content" id="content" pageids="kmath-memory::space.kscience.kmath.memory/Memory.Companion///PointingToDeclaration//1114102424">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../../index.html">kmath-memory</a>/<a href="../../index.html">space.kscience.kmath.memory</a>/<a href="../index.html">Memory</a>/<a href="index.html">Companion</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-memory:dokkaHtmlPartial/commonMain">common</button><button class="platform-tag platform-selector js-like" data-active="" data-filter=":kmath-memory:dokkaHtmlPartial/jsMain">js</button><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":kmath-memory:dokkaHtmlPartial/jvmMain">jvm</button><button class="platform-tag platform-selector native-like" data-active="" data-filter=":kmath-memory:dokkaHtmlPartial/nativeMain">native</button></div>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Companion</span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/commonMain"><div class="symbol monospace">object <a href="index.html">Companion</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="Extensions">Extensions</button><button class="section-tab" data-togglable="Sources">Sources</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="tabbedcontent">Extensions</h2>
|
|
<div class="table" data-togglable="Extensions"><a data-name="-1811990695%2FExtensions%2F1785411064" anchor-label="allocate" id="-1811990695%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="../../allocate.html">allocate</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1811990695%2FExtensions%2F1785411064"></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="divergent-group" data-filterable-current=":kmath-memory:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right">
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
</span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/commonMain"><div class="symbol monospace">fun <a href="index.html">Memory.Companion</a>.<a href="../../allocate.html">allocate</a>(length: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>): <a href="../index.html">Memory</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="-1811990695%2FExtensions%2F1785411064" anchor-label="allocate" id="-1811990695%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a><div class="brief "><a data-name="-1811990695%2FExtensions%2F1114102424" anchor-label="allocate" id="-1811990695%2FExtensions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>Allocates the most effective platform-specific memory.</div></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-memory:dokkaHtmlPartial/jsMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jsMain"><div class="with-platform-tags"><span class="pull-right">
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag js-like">js</div>
|
|
</div>
|
|
</span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/jsMain"><div class="symbol monospace">fun <a href="index.html#-1476492084%2FExtensions%2F449431098">Memory.Companion</a>.<a href="../../allocate.html">allocate</a>(length: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>): <a href="../index.html">Memory</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="-1811990695%2FExtensions%2F1785411064" anchor-label="allocate" id="-1811990695%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a><div class="brief "><a data-name="-1811990695%2FExtensions%2F449431098" anchor-label="allocate" id="-1811990695%2FExtensions%2F449431098" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jsMain"></a>Allocates memory based on a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.khronos.webgl/-data-view/index.html">DataView</a>.</div></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-memory:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jvmMain"><div class="with-platform-tags"><span class="pull-right">
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
</span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/jvmMain"><div class="symbol monospace">fun <a href="index.html#-1476492084%2FExtensions%2F341816670">Memory.Companion</a>.<a href="../../allocate.html">allocate</a>(length: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>): <a href="../index.html">Memory</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="-1811990695%2FExtensions%2F1785411064" anchor-label="allocate" id="-1811990695%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a><div class="brief "><a data-name="-1811990695%2FExtensions%2F341816670" anchor-label="allocate" id="-1811990695%2FExtensions%2F341816670" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jvmMain"></a>Allocates memory based on a <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html">ByteBuffer</a>.</div></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-memory:dokkaHtmlPartial/nativeMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/nativeMain"><div class="with-platform-tags"><span class="pull-right">
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag native-like">native</div>
|
|
</div>
|
|
</span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/nativeMain"><div class="symbol monospace">fun <a href="index.html#-1476492084%2FExtensions%2F-853052820">Memory.Companion</a>.<a href="../../allocate.html">allocate</a>(length: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>): <a href="../index.html">Memory</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="-1811990695%2FExtensions%2F1785411064" anchor-label="allocate" id="-1811990695%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a><div class="brief "><a data-name="-1811990695%2FExtensions%2F-853052820" anchor-label="allocate" id="-1811990695%2FExtensions%2F-853052820" data-filterable-set=":kmath-memory:dokkaHtmlPartial/nativeMain"></a>Allocates the most effective platform-specific memory.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1888438742%2FExtensions%2F1785411064" anchor-label="wrap" id="-1888438742%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="../../wrap.html">wrap</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1888438742%2FExtensions%2F1785411064"></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="divergent-group" data-filterable-current=":kmath-memory:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right">
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
</span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/commonMain"><div class="symbol monospace">fun <a href="index.html">Memory.Companion</a>.<a href="../../wrap.html">wrap</a>(array: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>): <a href="../index.html">Memory</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="-1888438742%2FExtensions%2F1785411064" anchor-label="wrap" id="-1888438742%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a><div class="brief "><a data-name="-1888438742%2FExtensions%2F1114102424" anchor-label="wrap" id="-1888438742%2FExtensions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>Wraps a <a href="../index.html">Memory</a> around existing <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>.</div></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-memory:dokkaHtmlPartial/jsMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jsMain"><div class="with-platform-tags"><span class="pull-right">
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag js-like">js</div>
|
|
</div>
|
|
</span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/jsMain"><div class="symbol monospace">fun <a href="index.html#-1476492084%2FExtensions%2F449431098">Memory.Companion</a>.<a href="../../wrap.html">wrap</a>(array: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>): <a href="../index.html">Memory</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="-1888438742%2FExtensions%2F1785411064" anchor-label="wrap" id="-1888438742%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a><div class="brief "><a data-name="-1888438742%2FExtensions%2F449431098" anchor-label="wrap" id="-1888438742%2FExtensions%2F449431098" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jsMain"></a>Wraps a <a href="../index.html">Memory</a> around existing <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>.</div></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-memory:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jvmMain"><div class="with-platform-tags"><span class="pull-right">
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag jvm-like">jvm</div>
|
|
</div>
|
|
</span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/jvmMain"><div class="symbol monospace">fun <a href="index.html#-1476492084%2FExtensions%2F341816670">Memory.Companion</a>.<a href="../../wrap.html">wrap</a>(array: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>): <a href="../index.html">Memory</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="-1888438742%2FExtensions%2F1785411064" anchor-label="wrap" id="-1888438742%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a><div class="brief "><a data-name="-1888438742%2FExtensions%2F341816670" anchor-label="wrap" id="-1888438742%2FExtensions%2F341816670" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jvmMain"></a>Wraps a <a href="../index.html">Memory</a> around existing <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>.</div></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-memory:dokkaHtmlPartial/nativeMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/nativeMain"><div class="with-platform-tags"><span class="pull-right">
|
|
<div class="platform-tags ">
|
|
<div class="platform-tag native-like">native</div>
|
|
</div>
|
|
</span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/nativeMain"><div class="symbol monospace">fun <a href="index.html#-1476492084%2FExtensions%2F-853052820">Memory.Companion</a>.<a href="../../wrap.html">wrap</a>(array: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>): <a href="../index.html">Memory</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="-1888438742%2FExtensions%2F1785411064" anchor-label="wrap" id="-1888438742%2FExtensions%2F1785411064" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain"></a><div class="brief "><a data-name="-1888438742%2FExtensions%2F-853052820" anchor-label="wrap" id="-1888438742%2FExtensions%2F-853052820" data-filterable-set=":kmath-memory:dokkaHtmlPartial/nativeMain"></a>Wraps a <a href="../index.html">Memory</a> around existing <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Sources</h2>
|
|
<div class="table" data-togglable="Sources"><a data-name="-1476492084%2FSource%2F1114102424" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-memory/src/commonMain/kotlin/space/kscience/kmath/memory/Memory.kt#L40" id="-1476492084%2FSource%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-memory:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="https://github.com/mipt-npm/kmath/tree/master/kmath-memory/src/commonMain/kotlin/space/kscience/kmath/memory/Memory.kt#L40">common source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1476492084%2FSource%2F1114102424"></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>© 2021 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>
|
|
|
|
|