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 > space.kscience.kmath.streaming< / 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-coroutines: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 = "package" id = "content" pageids = "kmath-coroutines::space.kscience.kmath.streaming////PointingToDeclaration//-205805890" >
< div class = "breadcrumbs" > < a href = "../index.html" > kmath-coroutines< / a > < span class = "delimiter" > /< / span > < span class = "current" > space.kscience.kmath.streaming< / span > < / div >
< div class = "cover " >
< h1 class = "cover" > < span > < span > Package-level< / span > < / span > < span > < span > declarations< / span > < / span > < / h1 >
< / div >
< div class = "tabbedcontent" >
< div class = "tabs-section" tabs-section = "tabs-section" > < button class = "section-tab" data-active = "" data-togglable = "TYPE" > Types< / button > < button class = "section-tab" data-togglable = "FUNCTION,EXTENSION_FUNCTION" > Functions< / button > < / div >
< div class = "tabs-section-body" >
< div data-togglable = "TYPE" >
< h2 class = "" > Types< / h2 >
< div class = "table" > < a data-name = "2143907756%2FClasslikes%2F-205805890" anchor-label = "RingBuffer" id = "2143907756%2FClasslikes%2F-205805890" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "-ring-buffer/index.html" > < span > Ring< / span > < wbr > < span > < span > Buffer< / span > < / span > < / a > < / div >
2022-04-12 11:30:54 +03:00
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "2143907756%2FClasslikes%2F-205805890" > < / 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-coroutines:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > class < / span > < a href = "-ring-buffer/index.html" > RingBuffer< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "-ring-buffer/index.html" > T< / a > < span class = "token operator" > > < / span > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > buffer< span class = "token operator" > : < / span > < a href = "../../kmath-core/space.kscience.kmath.structures/-mutable-buffer/index.html" > MutableBuffer< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "-ring-buffer/index.html" > T< / a > < span class = "token operator" > ?< / span > < span class = "token operator" > > < / span > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > startIndex< span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html" > Int< / a > < span class = "token operator" > = < / span > < span class = "token constant" > 0< / span > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > size< span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html" > Int< / a > < span class = "token operator" > = < / span > < span class = "token constant" > 0< / span > < / span > < / span > < span class = "token punctuation" > )< / span > : < a href = "../../kmath-core/space.kscience.kmath.structures/-buffer/index.html" > Buffer< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "-ring-buffer/index.html" > T< / a > < span class = "token operator" > > < / span > < / div > < div class = "brief " > < p class = "paragraph" > Thread-safe ring buffer< / 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 = "EXTENSION_FUNCTION" >
< h2 class = "" > Functions< / h2 >
< div class = "table" > < a data-name = "-1654500665%2FFunctions%2F-205805890" anchor-label = "asFlow" id = "-1654500665%2FFunctions%2F-205805890" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-togglable = "EXTENSION_FUNCTION" data-filterable-current = ":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "as-flow.html" > < span > as< / span > < wbr > < span > < span > Flow< / span > < / span > < / a > < / div >
2022-04-12 11:30:54 +03:00
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1654500665%2FFunctions%2F-205805890" > < / 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-coroutines:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "as-flow.html" > T< / a > < span class = "token operator" > > < / span > < a href = "../../kmath-core/space.kscience.kmath.structures/-buffer/index.html" > Buffer< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "as-flow.html" > T< / a > < span class = "token operator" > > < / span > < span class = "token punctuation" > .< / span > < a href = "as-flow.html" > < span class = "token function" > asFlow< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "as-flow.html" > T< / a > < span class = "token operator" > > < / span > < / div > < div class = "brief " > < p class = "paragraph" > Create a < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > from buffer< / p > < / div > < / div > < / div >
2021-03-12 21:24:01 +03:00
< / div >
2023-04-09 11:31:42 +03:00
< / div >
< / div >
< / div >
< a data-name = "-557702171%2FFunctions%2F-205805890" anchor-label = "chunked" id = "-557702171%2FFunctions%2F-205805890" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-togglable = "EXTENSION_FUNCTION" data-filterable-current = ":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "chunked.html" > < span > < span > chunked< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-557702171%2FFunctions%2F-205805890" > < / 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-coroutines:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html" > Double< / a > < span class = "token operator" > > < / span > < span class = "token punctuation" > .< / span > < a href = "chunked.html" > < span class = "token function" > chunked< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > bufferSize< 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 = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "../../kmath-core/space.kscience.kmath.structures/-double-buffer/index.html" > DoubleBuffer< / a > < span class = "token operator" > > < / span > < / div > < div class = "brief " > < p class = "paragraph" > Specialized flow chunker for real buffer< / p > < / div > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "chunked.html" > T< / a > < span class = "token operator" > > < / span > < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "chunked.html" > T< / a > < span class = "token operator" > > < / span > < span class = "token punctuation" > .< / span > < a href = "chunked.html" > < span class = "token function" > chunked< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > bufferSize< 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 " > bufferFactory< span class = "token operator" > : < / span > < a href = "../../kmath-core/space.kscience.kmath.structures/-buffer-factory/index.html" > BufferFactory< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "chunked.html" > T< / a > < span class = "token operator" > > < / span > < / span > < / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "../../kmath-core/space.kscience.kmath.structures/-buffer/index.html" > Buffer< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "chunked.html" > T< / a > < span class = "token operator" > > < / span > < span class = "token operator" > > < / span > < / div > < div class = "brief " > < p class = "paragraph" > Collect incoming flow into fixed size chunks< / 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 = "-1532011996%2FFunctions%2F-205805890" anchor-label = "spread" id = "-1532011996%2FFunctions%2F-205805890" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" > < / a >
2023-04-09 11:31:42 +03:00
< div class = "table-row" data-togglable = "EXTENSION_FUNCTION" data-filterable-current = ":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "spread.html" > < span > < span > spread< / span > < / span > < / a > < / div >
2022-04-12 11:30:54 +03:00
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1532011996%2FFunctions%2F-205805890" > < / 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-coroutines:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "spread.html" > T< / a > < span class = "token operator" > > < / span > < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "../../kmath-core/space.kscience.kmath.structures/-buffer/index.html" > Buffer< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "spread.html" > T< / a > < span class = "token operator" > > < / span > < span class = "token operator" > > < / span > < span class = "token punctuation" > .< / span > < a href = "spread.html" > < span class = "token function" > spread< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "spread.html" > T< / a > < span class = "token operator" > > < / span > < / div > < div class = "brief " > < p class = "paragraph" > Flat map a < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > of < a href = "../../kmath-core/space.kscience.kmath.structures/-buffer/index.html" > Buffer< / a > into continuous < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > of elements< / 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 = "-979748088%2FFunctions%2F-205805890" anchor-label = "windowed" id = "-979748088%2FFunctions%2F-205805890" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" > < / a >
2023-04-09 11:31:42 +03:00
< div class = "table-row" data-togglable = "EXTENSION_FUNCTION" data-filterable-current = ":kmath-coroutines:dokkaHtmlPartial/commonMain" data-filterable-set = ":kmath-coroutines:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "windowed.html" > < span > < span > windowed< / span > < / span > < / a > < / div >
2022-04-12 11:30:54 +03:00
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-979748088%2FFunctions%2F-205805890" > < / 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-coroutines:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "windowed.html" > T< / a > < span class = "token operator" > > < / span > < a href = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "windowed.html" > T< / a > < span class = "token operator" > > < / span > < span class = "token punctuation" > .< / span > < a href = "windowed.html" > < span class = "token function" > windowed< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > window< 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 = "https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html" > Flow< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "../../kmath-core/space.kscience.kmath.structures/-buffer/index.html" > Buffer< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "windowed.html" > T< / a > < span class = "token operator" > > < / span > < span class = "token operator" > > < / span > < / div > < div class = "brief " > < p class = "paragraph" > Map a flow to a moving window buffer. The window step is one. To get different steps, one could use skip operation.< / p > < / div > < / div > < / div >
2021-03-12 21:24:01 +03:00
< / div >
< / div >
< / 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
