forked from kscience/kmath
217 lines
23 KiB
HTML
217 lines
23 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>Memory</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///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></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></div>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Memory</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">interface <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><p class="paragraph">Represents a display of certain memory structure.</p></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button><button class="section-tab" data-togglable="Extensions">Extensions</button><button class="section-tab" data-togglable="Sources">Sources</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Types</h2>
|
|
<div class="table" data-togglable="Types"><a data-name="-1476492084%2FClasslikes%2F1114102424" anchor-label="Companion" id="-1476492084%2FClasslikes%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="-companion/index.html">Companion</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1476492084%2FClasslikes%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 class="platform-tags ">
|
|
<div class="platform-tag common-like">common</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"></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">object <a href="-companion/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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="-1766062816%2FFunctions%2F1114102424" anchor-label="copy" id="-1766062816%2FFunctions%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="copy.html">copy</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1766062816%2FFunctions%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 class="platform-tags ">
|
|
<div class="platform-tag common-like">common</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"></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">abstract fun <a href="copy.html">copy</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="-1766062816%2FFunctions%2F1114102424" anchor-label="copy" id="-1766062816%2FFunctions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="-1766062816%2FFunctions%2F1114102424" anchor-label="copy" id="-1766062816%2FFunctions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>Creates an independent copy of this memory.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1694294418%2FFunctions%2F1114102424" anchor-label="reader" id="1694294418%2FFunctions%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="reader.html">reader</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1694294418%2FFunctions%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 class="platform-tags ">
|
|
<div class="platform-tag common-like">common</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"></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">abstract fun <a href="reader.html">reader</a>(): <a href="../-memory-reader/index.html">MemoryReader</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="1694294418%2FFunctions%2F1114102424" anchor-label="reader" id="1694294418%2FFunctions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="1694294418%2FFunctions%2F1114102424" anchor-label="reader" id="1694294418%2FFunctions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>Gets or creates a reader of this memory.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-450233585%2FFunctions%2F1114102424" anchor-label="view" id="-450233585%2FFunctions%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="view.html">view</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-450233585%2FFunctions%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 class="platform-tags ">
|
|
<div class="platform-tag common-like">common</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"></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">abstract fun <a href="view.html">view</a>(offset: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</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="-450233585%2FFunctions%2F1114102424" anchor-label="view" id="-450233585%2FFunctions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="-450233585%2FFunctions%2F1114102424" anchor-label="view" id="-450233585%2FFunctions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>Get a projection of this memory (it reflects the changes in the parent memory block).</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="769465314%2FFunctions%2F1114102424" anchor-label="writer" id="769465314%2FFunctions%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="writer.html">writer</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="769465314%2FFunctions%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 class="platform-tags ">
|
|
<div class="platform-tag common-like">common</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"></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">abstract fun <a href="writer.html">writer</a>(): <a href="../-memory-writer/index.html">MemoryWriter</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="769465314%2FFunctions%2F1114102424" anchor-label="writer" id="769465314%2FFunctions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="769465314%2FFunctions%2F1114102424" anchor-label="writer" id="769465314%2FFunctions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>Gets or creates a writer of this memory.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Properties</h2>
|
|
<div class="table" data-togglable="Properties"><a data-name="-1627108844%2FProperties%2F1114102424" anchor-label="size" id="-1627108844%2FProperties%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="size.html">size</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1627108844%2FProperties%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 class="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtmlPartial/commonMain"><a data-name="-1627108844%2FProperties%2F1114102424" anchor-label="size" id="-1627108844%2FProperties%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace">abstract val <a href="size.html">size</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</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 class="brief "><a data-name="-1627108844%2FProperties%2F1114102424" anchor-label="size" id="-1627108844%2FProperties%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>The length of this memory in bytes.</div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="tabbedcontent">Extensions</h2>
|
|
<div class="table" data-togglable="Extensions"><a data-name="-1687050409%2FExtensions%2F1114102424" anchor-label="read" id="-1687050409%2FExtensions%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="../read.html">read</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1687050409%2FExtensions%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 class="platform-tags ">
|
|
<div class="platform-tag common-like">common</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"></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">inline fun <<a href="../read.html">R</a>> <a href="index.html">Memory</a>.<a href="../read.html">read</a>(block: <a href="../-memory-reader/index.html">MemoryReader</a>.() -> <a href="../read.html">R</a>): <a href="../read.html">R</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="-1687050409%2FExtensions%2F1114102424" anchor-label="read" id="-1687050409%2FExtensions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="-1687050409%2FExtensions%2F1114102424" anchor-label="read" id="-1687050409%2FExtensions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>Uses the memory for read then releases the reader.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1515567299%2FExtensions%2F1114102424" anchor-label="write" id="-1515567299%2FExtensions%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="../write.html">write</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1515567299%2FExtensions%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 class="platform-tags ">
|
|
<div class="platform-tag common-like">common</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"></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">inline fun <a href="index.html">Memory</a>.<a href="../write.html">write</a>(block: <a href="../-memory-writer/index.html">MemoryWriter</a>.() -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</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="-1515567299%2FExtensions%2F1114102424" anchor-label="write" id="-1515567299%2FExtensions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="-1515567299%2FExtensions%2F1114102424" anchor-label="write" id="-1515567299%2FExtensions%2F1114102424" data-filterable-set=":kmath-memory:dokkaHtmlPartial/commonMain"></a>Uses the memory for write then releases the writer.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Sources</h2>
|
|
<div class="table" data-togglable="Sources"><a data-name="105503946%2FSource%2F1114102424" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-memory/src/commonMain/kotlin/space/kscience/kmath/memory/Memory.kt#L11" id="105503946%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#L11">common source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="105503946%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>
|
|
|
|
|