176 lines
21 KiB
HTML
176 lines
21 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>MemorySpec</title>
|
|
<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="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="async"></script>
|
|
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
|
|
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
|
|
<script type="text/javascript" src="../../../scripts/main.js" async="async"></script>
|
|
</head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn">
|
|
<div id="logo"></div>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../../scripts/pages.js"></script>
|
|
<script type="text/javascript" src="../../../scripts/main.js"></script>
|
|
<div class="main-content" id="content" pageIds="space.kscience.kmath.memory/MemorySpec///PointingToDeclaration//882494181">
|
|
<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">MemorySpec</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:dokkaHtml/commonMain">common</button></div>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Memory</span><wbr></wbr><span>Spec</span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtml/commonMain"><div class="symbol monospace">interface <a href="index.html">MemorySpec</a><<a href="index.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</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">A specification to read or write custom objects with fixed size in bytes.</p></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button><button class="section-tab" data-togglable="Parameters">Parameters</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Parameters</h2>
|
|
<div data-togglable="Parameters">
|
|
<div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-memory:dokkaHtml/commonMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":kmath-memory:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">T</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the type of object this spec manages.</p></div></div></div></div></div></div></div></div></div>
|
|
</div>
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" anchor-label="equals" id="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-memory:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181">equals</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181"></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:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/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:dokkaHtml/commonMain"><div class="symbol monospace">open operator fun <a href="index.html#%5Bkotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</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>
|
|
<a data-name="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" anchor-label="hashCode" id="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-memory:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181">hashCode</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181"></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:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/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:dokkaHtml/commonMain"><div class="symbol monospace">open fun <a href="index.html#%5Bkotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181">hashCode</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></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fread%2Fspace.kscience.kmath.memory.MemoryReader%23kotlin.Int%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" anchor-label="read" id="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fread%2Fspace.kscience.kmath.memory.MemoryReader%23kotlin.Int%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-memory:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/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="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fread%2Fspace.kscience.kmath.memory.MemoryReader%23kotlin.Int%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181"></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:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/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:dokkaHtml/commonMain"><div class="symbol monospace">abstract fun <a href="../-memory-reader/index.html">MemoryReader</a>.<a href="read.html">read</a>(offset: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>): <a href="index.html">T</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="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fread%2Fspace.kscience.kmath.memory.MemoryReader%23kotlin.Int%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" anchor-label="read" id="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fread%2Fspace.kscience.kmath.memory.MemoryReader%23kotlin.Int%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a><div class="brief "><a data-name="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fread%2Fspace.kscience.kmath.memory.MemoryReader%23kotlin.Int%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" anchor-label="read" id="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fread%2Fspace.kscience.kmath.memory.MemoryReader%23kotlin.Int%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a>Reads the object starting from <span data-unresolved-link="space.kscience.kmath.memory/MemorySpec/offset/#/PointingToCallableParameters(-1)/">offset</span>.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" anchor-label="toString" id="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-memory:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181">toString</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181"></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:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/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:dokkaHtml/commonMain"><div class="symbol monospace">open fun <a href="index.html#%5Bkotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181">toString</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</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>
|
|
<a data-name="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fwrite%2Fspace.kscience.kmath.memory.MemoryWriter%23kotlin.Int%23TypeParam%28bounds%3D%5Bkotlin.Any%5D%29%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" anchor-label="write" id="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fwrite%2Fspace.kscience.kmath.memory.MemoryWriter%23kotlin.Int%23TypeParam%28bounds%3D%5Bkotlin.Any%5D%29%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-memory:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/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="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fwrite%2Fspace.kscience.kmath.memory.MemoryWriter%23kotlin.Int%23TypeParam%28bounds%3D%5Bkotlin.Any%5D%29%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181"></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:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/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:dokkaHtml/commonMain"><div class="symbol monospace">abstract fun <a href="../-memory-writer/index.html">MemoryWriter</a>.<a href="write.html">write</a>(offset: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>, value: <a href="index.html">T</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="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fwrite%2Fspace.kscience.kmath.memory.MemoryWriter%23kotlin.Int%23TypeParam%28bounds%3D%5Bkotlin.Any%5D%29%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" anchor-label="write" id="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fwrite%2Fspace.kscience.kmath.memory.MemoryWriter%23kotlin.Int%23TypeParam%28bounds%3D%5Bkotlin.Any%5D%29%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a><div class="brief "><a data-name="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fwrite%2Fspace.kscience.kmath.memory.MemoryWriter%23kotlin.Int%23TypeParam%28bounds%3D%5Bkotlin.Any%5D%29%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" anchor-label="write" id="%5Bspace.kscience.kmath.memory%2FMemorySpec%2Fwrite%2Fspace.kscience.kmath.memory.MemoryWriter%23kotlin.Int%23TypeParam%28bounds%3D%5Bkotlin.Any%5D%29%2FPointingToDeclaration%2F%5D%2FFunctions%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a>Writes the object <span data-unresolved-link="space.kscience.kmath.memory/MemorySpec/value/#/PointingToCallableParameters(-1)/">value</span> starting from <span data-unresolved-link="space.kscience.kmath.memory/MemorySpec/offset/#/PointingToCallableParameters(-1)/">offset</span>.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Properties</h2>
|
|
<div class="table" data-togglable="Properties"><a data-name="%5Bspace.kscience.kmath.memory%2FMemorySpec%2FobjectSize%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F882494181" anchor-label="objectSize" id="%5Bspace.kscience.kmath.memory%2FMemorySpec%2FobjectSize%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-memory:dokkaHtml/commonMain" data-filterable-set=":kmath-memory:dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="object-size.html">objectSize</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bspace.kscience.kmath.memory%2FMemorySpec%2FobjectSize%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F882494181"></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:dokkaHtml/commonMain"><a data-name="%5Bspace.kscience.kmath.memory%2FMemorySpec%2FobjectSize%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F882494181" anchor-label="objectSize" id="%5Bspace.kscience.kmath.memory%2FMemorySpec%2FobjectSize%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a><div class="symbol monospace">abstract val <a href="object-size.html">objectSize</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="%5Bspace.kscience.kmath.memory%2FMemorySpec%2FobjectSize%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F882494181" anchor-label="objectSize" id="%5Bspace.kscience.kmath.memory%2FMemorySpec%2FobjectSize%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F882494181" data-filterable-set=":kmath-memory:dokkaHtml/commonMain"></a>Size of <a href="index.html">T</a> in bytes after serialization.</div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"></span></a></span></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|