114 lines
22 KiB
HTML
114 lines
22 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-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>
|
|
<button class="platform-tag platform-selector wasm-like" data-active="" data-filter=":kmath-memory:dokkaHtmlPartial/wasmMain">wasm</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-memory::space.kscience.kmath.memory/Memory.Companion///PointingToDeclaration//1114102424">
|
|
<div class="breadcrumbs"><a href="../../../index.html">kmath-memory</a><span class="delimiter">/</span><a href="../../index.html">space.kscience.kmath.memory</a><span class="delimiter">/</span><a href="../index.html">Memory</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-memory: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-memory/src/commonMain/kotlin/space/kscience/kmath/memory/Memory.kt#L40">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="-1811990695%2FFunctions%2F320667571" anchor-label="allocate" id="-1811990695%2FFunctions%2F320667571" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain :kmath-memory:dokkaHtmlPartial/wasmMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain :kmath-memory:dokkaHtmlPartial/wasmMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain :kmath-memory:dokkaHtmlPartial/wasmMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../allocate.html"><span><span>allocate</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1811990695%2FFunctions%2F320667571"></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-memory:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-memory:dokkaHtmlPartial/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":kmath-memory:dokkaHtmlPartial/jsMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jsMain" data-toggle=":kmath-memory:dokkaHtmlPartial/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":kmath-memory:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jvmMain" data-toggle=":kmath-memory:dokkaHtmlPartial/jvmMain">jvm</button><button class="platform-bookmark" data-filterable-current=":kmath-memory:dokkaHtmlPartial/nativeMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/nativeMain" data-toggle=":kmath-memory:dokkaHtmlPartial/nativeMain">native</button><button class="platform-bookmark" data-filterable-current=":kmath-memory:dokkaHtmlPartial/wasmMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/wasmMain" data-toggle=":kmath-memory:dokkaHtmlPartial/wasmMain">wasm</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html">Memory.Companion</a><span class="token punctuation">.</span><a href="../../allocate.html"><span class="token function">allocate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">length<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">Memory</a></div><div class="brief "><p class="paragraph">Allocates the most effective platform-specific memory.</p></div></div><div class="content sourceset-dependent-content" data-togglable=":kmath-memory:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html#-1476492084%2FMain%2F449431098">Memory.Companion</a><span class="token punctuation">.</span><a href="../../allocate.html"><span class="token function">allocate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">length<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a></div><div class="brief "><p class="paragraph">Allocates memory based on a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.khronos.webgl/-data-view/index.html">DataView</a>.</p></div></div><div class="content sourceset-dependent-content" data-togglable=":kmath-memory:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html#-1476492084%2FMain%2F341816670">Memory.Companion</a><span class="token punctuation">.</span><a href="../../allocate.html"><span class="token function">allocate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">length<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a></div><div class="brief "><p class="paragraph">Allocates memory based on a <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html">ByteBuffer</a>.</p></div></div><div class="content sourceset-dependent-content" data-togglable=":kmath-memory:dokkaHtmlPartial/nativeMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html#-1476492084%2FMain%2F-853052820">Memory.Companion</a><span class="token punctuation">.</span><a href="../../allocate.html"><span class="token function">allocate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">length<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a></div><div class="brief "><p class="paragraph">Allocates the most effective platform-specific memory.</p></div></div><div class="content sourceset-dependent-content" data-togglable=":kmath-memory:dokkaHtmlPartial/wasmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html#-1476492084%2FMain%2F653537183">Memory.Companion</a><span class="token punctuation">.</span><a href="../../allocate.html"><span class="token function">allocate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">length<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a></div><div class="brief "><p class="paragraph">Allocates memory based on a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.khronos.webgl/-data-view/index.html">DataView</a>.</p></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1888438742%2FFunctions%2F320667571" anchor-label="wrap" id="-1888438742%2FFunctions%2F320667571" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain :kmath-memory:dokkaHtmlPartial/wasmMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain :kmath-memory:dokkaHtmlPartial/wasmMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain :kmath-memory:dokkaHtmlPartial/jsMain :kmath-memory:dokkaHtmlPartial/jvmMain :kmath-memory:dokkaHtmlPartial/nativeMain :kmath-memory:dokkaHtmlPartial/wasmMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../wrap.html"><span><span>wrap</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1888438742%2FFunctions%2F320667571"></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-memory:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-memory:dokkaHtmlPartial/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":kmath-memory:dokkaHtmlPartial/jsMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jsMain" data-toggle=":kmath-memory:dokkaHtmlPartial/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":kmath-memory:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/jvmMain" data-toggle=":kmath-memory:dokkaHtmlPartial/jvmMain">jvm</button><button class="platform-bookmark" data-filterable-current=":kmath-memory:dokkaHtmlPartial/nativeMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/nativeMain" data-toggle=":kmath-memory:dokkaHtmlPartial/nativeMain">native</button><button class="platform-bookmark" data-filterable-current=":kmath-memory:dokkaHtmlPartial/wasmMain" data-filterable-set=":kmath-memory:dokkaHtmlPartial/wasmMain" data-toggle=":kmath-memory:dokkaHtmlPartial/wasmMain">wasm</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html">Memory.Companion</a><span class="token punctuation">.</span><a href="../../wrap.html"><span class="token function">wrap</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">array<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">Memory</a></div><div class="brief "><p class="paragraph">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>. This operation is unsafe since the array is not copied and could be mutated independently of the resulting <a href="../index.html">Memory</a>.</p></div></div><div class="content sourceset-dependent-content" data-togglable=":kmath-memory:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html#-1476492084%2FMain%2F449431098">Memory.Companion</a><span class="token punctuation">.</span><a href="../../wrap.html"><span class="token function">wrap</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">array<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a></div><div class="brief "><p class="paragraph">Wraps a <a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a> around existing <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>. This operation is unsafe since the array is not copied and could be mutated independently of the resulting <a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a>.</p></div></div><div class="content sourceset-dependent-content" data-togglable=":kmath-memory:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html#-1476492084%2FMain%2F341816670">Memory.Companion</a><span class="token punctuation">.</span><a href="../../wrap.html"><span class="token function">wrap</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">array<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a></div><div class="brief "><p class="paragraph">Wraps a <a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a> around existing <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>. This operation is unsafe since the array is not copied and could be mutated independently of the resulting <a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a>.</p></div></div><div class="content sourceset-dependent-content" data-togglable=":kmath-memory:dokkaHtmlPartial/nativeMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html#-1476492084%2FMain%2F-853052820">Memory.Companion</a><span class="token punctuation">.</span><a href="../../wrap.html"><span class="token function">wrap</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">array<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a></div><div class="brief "><p class="paragraph">Wraps a <a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a> around existing <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>. This operation is unsafe since the array is not copied and could be mutated independently of the resulting <a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a>.</p></div></div><div class="content sourceset-dependent-content" data-togglable=":kmath-memory:dokkaHtmlPartial/wasmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="index.html#-1476492084%2FMain%2F653537183">Memory.Companion</a><span class="token punctuation">.</span><a href="../../wrap.html"><span class="token function">wrap</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">array<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a></div><div class="brief "><p class="paragraph">Wraps a <a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a> around existing <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>. This operation is unsafe since the array is not copied and could be mutated independently of the resulting <a href="../../../../kmath-memory/space.kscience.kmath.memory/-memory/index.html">Memory</a>.</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>
|
|
|