dataforge-core/dataforge-data/space.kscience.dataforge.data/select.html

48 lines
7.2 KiB
HTML
Raw Normal View History

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>select</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="dataforge-data::space.kscience.dataforge.data//select/space.kscience.dataforge.data.DataSet[*]#kotlin.reflect.KType#space.kscience.dataforge.names.Name?#kotlin.Function2[space.kscience.dataforge.names.Name,space.kscience.dataforge.meta.Meta,kotlin.Boolean]/PointingToDeclaration//-1140187907">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../index.html">dataforge-data</a>/<a href="index.html">space.kscience.dataforge.data</a>/<a href="select.html">select</a></div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dataforge-data:dokkaHtmlPartial/jvmMain">jvm</button></div>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span><span>select</span></span></h1>
</div>
<div class="divergent-group" data-filterable-current=":dataforge-data:dokkaHtmlPartial/jvmMain" data-filterable-set=":dataforge-data:dokkaHtmlPartial/jvmMain"><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=":dataforge-data:dokkaHtmlPartial/jvmMain"><div class="symbol monospace">fun &lt;<a href="select.html">R</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>&gt; <a href="-data-set/index.html#-1723708640%2FExtensions%2F-1140187907">DataSet</a>&lt;*&gt;.<a href="select.html">select</a>(type: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a>, namePattern: <a href="../../dataforge-meta/space.kscience.dataforge.names/-name/index.html">Name</a>? = null, filter: (name: <a href="../../dataforge-meta/space.kscience.dataforge.names/-name/index.html">Name</a>, meta: <a href="../../dataforge-meta/space.kscience.dataforge.meta/-meta/index.html">Meta</a>) -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = { _, _ -&gt; true }): <a href="../../dataforge-data/space.kscience.dataforge.data/-active-data-set/index.html">ActiveDataSet</a>&lt;<a href="select.html">R</a>&gt;<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>
<p class="paragraph">Select all data matching given type and filters. Does not modify paths</p><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=":dataforge-data:dokkaHtmlPartial/jvmMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dataforge-data:dokkaHtmlPartial/jvmMain" data-filterable-set=":dataforge-data:dokkaHtmlPartial/jvmMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span>name</span><wbr><span><span>Pattern</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">a name match patter according to <a href="../../dataforge-meta/space.kscience.dataforge.names/index.html">Name.matches</a></p></div></div></div></div></div><div class="table-row" data-filterable-current=":dataforge-data:dokkaHtmlPartial/jvmMain" data-filterable-set=":dataforge-data:dokkaHtmlPartial/jvmMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span><span>filter</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">addition filtering condition based on item name and meta. By default, accepts all</p></div></div></div></div></div></div></div></div></div></div></div>
<div class="divergent-group" data-filterable-current=":dataforge-data:dokkaHtmlPartial/jvmMain" data-filterable-set=":dataforge-data:dokkaHtmlPartial/jvmMain"><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=":dataforge-data:dokkaHtmlPartial/jvmMain"><div class="symbol monospace">inline fun &lt;<a href="select.html">R</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>&gt; <a href="-data-set/index.html#-1723708640%2FExtensions%2F-1140187907">DataSet</a>&lt;*&gt;.<a href="select.html">select</a>(namePattern: <a href="../../dataforge-meta/space.kscience.dataforge.names/-name/index.html">Name</a>? = null, noinline filter: (name: <a href="../../dataforge-meta/space.kscience.dataforge.names/-name/index.html">Name</a>, meta: <a href="../../dataforge-meta/space.kscience.dataforge.meta/-meta/index.html">Meta</a>) -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = { _, _ -&gt; true }): <a href="-data-set/index.html#-1723708640%2FExtensions%2F-1140187907">DataSet</a>&lt;<a href="select.html">R</a>&gt;<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>
<p class="paragraph">Select a single datum of the appropriate type</p></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>