forked from kscience/kmath
107 lines
16 KiB
HTML
107 lines
16 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>space.kscience.kmath.commons.transform</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-commons::space.kscience.kmath.commons.transform////PointingToDeclaration//-755866740">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../index.html">kmath-commons</a>/<a href="index.html">space.kscience.kmath.commons.transform</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Package space.</span><wbr><span>kscience.</span><wbr><span>kmath.</span><wbr><span>commons.</span><wbr><span>transform</span></h1>
|
|
</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></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Types</h2>
|
|
<div class="table" data-togglable="Types"><a data-name="730975160%2FClasslikes%2F-755866740" anchor-label="Transformations" id="730975160%2FClasslikes%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="-transformations/index.html">Transformations</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="730975160%2FClasslikes%2F-755866740"></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="divergent-group" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"><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-commons:dokkaHtmlPartial/main"><div class="symbol monospace">object <a href="-transformations/index.html">Transformations</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="730975160%2FClasslikes%2F-755866740" anchor-label="Transformations" id="730975160%2FClasslikes%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a><div class="brief "><a data-name="730975160%2FClasslikes%2F-755866740" anchor-label="Transformations" id="730975160%2FClasslikes%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>Streaming and buffer transformations</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="252866852%2FFunctions%2F-755866740" anchor-label="FFT" id="252866852%2FFunctions%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="-f-f-t.html">FFT</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="252866852%2FFunctions%2F-755866740"></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="divergent-group" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"><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-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-flow-preview/index.html">FlowPreview</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html">JvmName</a>(<span>name = <span class="breakable-word">realFFT</span></span><wbr>)</div></div>fun <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>>>.<a href="-f-f-t.html">FFT</a>(normalization: <a href="https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/org/apache/commons/math3/transform/DftNormalization.html">DftNormalization</a> = DftNormalization.STANDARD, direction: <a href="https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/org/apache/commons/math3/transform/TransformType.html">TransformType</a> = TransformType.FORWARD): <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><<a href="../../kmath-complex/space.kscience.kmath.complex/-complex/index.html">Complex</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 class="divergent-group" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"><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-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-flow-preview/index.html">FlowPreview</a>()</div></div>fun <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><<a href="../../kmath-complex/space.kscience.kmath.complex/-complex/index.html">Complex</a>>>.<a href="-f-f-t.html">FFT</a>(normalization: <a href="https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/org/apache/commons/math3/transform/DftNormalization.html">DftNormalization</a> = DftNormalization.STANDARD, direction: <a href="https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/org/apache/commons/math3/transform/TransformType.html">TransformType</a> = TransformType.FORWARD): <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><<a href="../../kmath-complex/space.kscience.kmath.complex/-complex/index.html">Complex</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="-1407346847%2FFunctions%2F-755866740" anchor-label="FFT" id="-1407346847%2FFunctions%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a><div class="brief "><a data-name="-1407346847%2FFunctions%2F-755866740" anchor-label="FFT" id="-1407346847%2FFunctions%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>Process given <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a> with commons-math fft transformation</div></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"><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-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-flow-preview/index.html">FlowPreview</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html">JvmName</a>(<span>name = <span class="breakable-word">realFFT</span></span><wbr>)</div></div>fun <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>>.<a href="-f-f-t.html">FFT</a>(bufferSize: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = Int.MAX_VALUE, normalization: <a href="https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/org/apache/commons/math3/transform/DftNormalization.html">DftNormalization</a> = DftNormalization.STANDARD, direction: <a href="https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/org/apache/commons/math3/transform/TransformType.html">TransformType</a> = TransformType.FORWARD): <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="../../kmath-complex/space.kscience.kmath.complex/-complex/index.html">Complex</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="1535896456%2FFunctions%2F-755866740" anchor-label="FFT" id="1535896456%2FFunctions%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a><div class="brief "><a data-name="1535896456%2FFunctions%2F-755866740" anchor-label="FFT" id="1535896456%2FFunctions%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>Process a continuous flow of real numbers in FFT splitting it in chunks of <a href="-f-f-t.html">bufferSize</a>.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-306533461%2FFunctions%2F-755866740" anchor-label="real" id="-306533461%2FFunctions%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="real.html">real</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-306533461%2FFunctions%2F-755866740"></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="divergent-group" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"><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-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines/-flow-preview/index.html">FlowPreview</a>()</div></div>fun <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="../../kmath-complex/space.kscience.kmath.complex/-complex/index.html">Complex</a>>.<a href="real.html">real</a>(): <a href="https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</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="-306533461%2FFunctions%2F-755866740" anchor-label="real" id="-306533461%2FFunctions%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a><div class="brief "><a data-name="-306533461%2FFunctions%2F-755866740" anchor-label="real" id="-306533461%2FFunctions%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>Map a complex flow into real flow by taking real part of each number</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>© 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>
|
|
|
|
|