2023-04-09 11:31:42 +03:00
<!doctype html>
2021-03-12 21:24:01 +03:00
< html >
2023-04-09 11:31:42 +03:00
< head >
2021-03-12 21:24:01 +03:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" charset = "UTF-8" >
< title > Memory< / 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 > c o n s t s t o r a g e = l o c a l S t o r a g e . g e t I t e m ( " d o k k a - d a r k - m o d e " )
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 >
< / 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-03-12 21:24:01 +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-memory::space.kscience.kmath.memory/Memory///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 > < span class = "current" > Memory< / span > < / div >
< div class = "cover " >
< h1 class = "cover" > < span > < span > Memory< / 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" > interface < / span > < a href = "index.html" > Memory< / 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#L14" > source< / a > )< / span > < / 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 = "CONSTRUCTOR,TYPE,FUNCTION,PROPERTY" > Members< / button > < button class = "section-tab" data-togglable = "CONSTRUCTOR,TYPE,FUNCTION,PROPERTY,EXTENSION_PROPERTY,EXTENSION_FUNCTION" > Members & Extensions< / button > < / div >
< div class = "tabs-section-body" >
< div data-togglable = "TYPE" >
< h2 class = "" > Types< / h2 >
< div class = "table" > < 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" >
< div > < a href = "-companion/index.html" > < span > < span > Companion< / span > < / span > < / a > < / div >
2022-04-12 11:30:54 +03:00
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1476492084%2FClasslikes%2F1114102424" > < / 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-memory:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > object < / span > < a href = "-companion/index.html" > Companion< / a > < / div > < / div > < / div >
2021-03-12 21:24:01 +03:00
< / div >
< / div >
2023-04-09 11:31:42 +03:00
< / div >
< / div >
< / div >
< / div >
< div data-togglable = "FUNCTION" >
< h2 class = "" > Functions< / h2 >
< div class = "table" > < 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" >
< div > < a href = "copy.html" > < span > < span > copy< / span > < / span > < / a > < / div >
2022-04-12 11:30:54 +03:00
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1766062816%2FFunctions%2F1114102424" > < / 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-memory:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > abstract < / span > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < a href = "copy.html" > < span class = "token function" > copy< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "index.html" > Memory< / a > < / div > < div class = "brief " > < p class = "paragraph" > Creates an independent copy of this memory.< / p > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1687050409%2FFunctions%2F1114102424" anchor-label = "read" id = "-1687050409%2FFunctions%2F1114102424" data-filterable-set = ":kmath-memory:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-togglable = "EXTENSION_FUNCTION" 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" >
< div > < a href = "../read.html" > < span > < span > read< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1687050409%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 = "title" >
< 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" > inline < / span > < span class = "token keyword" > fun < / span > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "../read.html" > R< / a > < span class = "token operator" > > < / span > < a href = "index.html" > Memory< / a > < span class = "token punctuation" > .< / span > < a href = "../read.html" > < span class = "token function" > read< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > block< span class = "token operator" > : < / span > < span class = "token keyword" > < / span > < a href = "../-memory-reader/index.html" > MemoryReader< / a > < span class = "token punctuation" > .< / span > < span class = "token punctuation" > (< / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > -> < / span > < span class = "token keyword" > < / span > < a href = "../read.html" > R< / a > < / span > < / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "../read.html" > R< / a > < / div > < div class = "brief " > < p class = "paragraph" > Uses the memory for read then releases the reader.< / p > < / div > < / div > < / div >
2021-03-12 21:24:01 +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 = "1694294418%2FFunctions%2F1114102424" anchor-label = "reader" id = "1694294418%2FFunctions%2F1114102424" data-filterable-set = ":kmath-memory:dokkaHtmlPartial/commonMain" > < / a >
2023-04-09 11:31:42 +03:00
< 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" >
< div > < a href = "reader.html" > < span > < span > reader< / span > < / span > < / a > < / div >
2022-04-12 11:30:54 +03:00
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1694294418%2FFunctions%2F1114102424" > < / 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-memory:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > abstract < / span > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < a href = "reader.html" > < span class = "token function" > reader< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "../-memory-reader/index.html" > MemoryReader< / a > < / div > < div class = "brief " > < p class = "paragraph" > Gets or creates a reader of this memory.< / p > < / div > < / div > < / div >
2021-03-12 21:24:01 +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 = "-450233585%2FFunctions%2F1114102424" anchor-label = "view" id = "-450233585%2FFunctions%2F1114102424" data-filterable-set = ":kmath-memory:dokkaHtmlPartial/commonMain" > < / a >
2023-04-09 11:31:42 +03:00
< 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" >
< div > < a href = "view.html" > < span > < span > view< / span > < / span > < / a > < / div >
2022-04-12 11:30:54 +03:00
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-450233585%2FFunctions%2F1114102424" > < / 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-memory:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > abstract < / span > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < a href = "view.html" > < span class = "token function" > view< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > offset< 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 " > 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" > Get a projection of this memory (it reflects the changes in the parent memory block).< / p > < / div > < / div > < / div >
2021-03-12 21:24:01 +03:00
< / div >
< / div >
2023-04-09 11:31:42 +03:00
< / div >
< / div >
< a data-name = "-1515567299%2FFunctions%2F1114102424" anchor-label = "write" id = "-1515567299%2FFunctions%2F1114102424" data-filterable-set = ":kmath-memory:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-togglable = "EXTENSION_FUNCTION" 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" >
< div > < a href = "../write.html" > < span > < span > write< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1515567299%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 = "title" >
< 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" > inline < / span > < span class = "token keyword" > fun < / span > < a href = "index.html" > Memory< / a > < span class = "token punctuation" > .< / span > < a href = "../write.html" > < span class = "token function" > write< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > block< span class = "token operator" > : < / span > < span class = "token keyword" > < / span > < a href = "../-memory-writer/index.html" > MemoryWriter< / a > < span class = "token punctuation" > .< / span > < span class = "token punctuation" > (< / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > -> < / span > < span class = "token keyword" > < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html" > Unit< / a > < / span > < / span > < span class = "token punctuation" > )< / span > < / div > < div class = "brief " > < p class = "paragraph" > Uses the memory for write then releases the writer.< / p > < / div > < / div > < / div >
2021-03-12 21:24:01 +03:00
< / div >
< / div >
2023-04-09 11:31:42 +03:00
< / 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" >
< div > < a href = "writer.html" > < span > < span > writer< / span > < / span > < / a > < / div >
< 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 = "title" >
< 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" > abstract < / span > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < a href = "writer.html" > < span class = "token function" > writer< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "../-memory-writer/index.html" > MemoryWriter< / a > < / div > < div class = "brief " > < p class = "paragraph" > Gets or creates a writer of this memory.< / p > < / div > < / div > < / div >
2021-03-12 21:24:01 +03:00
< / div >
< / div >
2023-04-09 11:31:42 +03:00
< / div >
< / div >
< / div >
< / div >
< div data-togglable = "PROPERTY" >
< h2 class = "" > Properties< / h2 >
< div class = "table" > < 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" >
< div > < a href = "size.html" > < span > < span > size< / span > < / span > < / a > < / div >
< 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 = "title" >
< 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" > abstract < / span > < span class = "token keyword" > < / span > < span class = "token keyword" > val < / span > < a href = "size.html" > size< / a > < span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html" > Int< / a > < / div > < div class = "brief " > < p class = "paragraph" > The length of this memory in bytes.< / p > < / div > < / div > < / div >
2021-10-13 15:08:46 +03:00
< / div >
< / div >
2021-03-12 21:24:01 +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-03-12 21:24:01 +03:00
