kmath/test-utils/space.kscience.kmath.testutils/index.html

154 lines
21 KiB
HTML

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.kmath.testutils</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode")
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=":test-utils:dokkaHtmlPartial/commonMain">common</button>
</div>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="package" id="content" pageids="test-utils::space.kscience.kmath.testutils////PointingToDeclaration//219969693">
<div class="breadcrumbs"><a href="../index.html">test-utils</a><span class="delimiter">/</span><span class="current">space.kscience.kmath.testutils</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="-1013544263%2FClasslikes%2F219969693" anchor-label="FieldVerifier" id="-1013544263%2FClasslikes%2F219969693" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":test-utils:dokkaHtmlPartial/commonMain" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-field-verifier/index.html"><span>Field</span><wbr><span><span>Verifier</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1013544263%2FClasslikes%2F219969693"></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=":test-utils:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-field-verifier/index.html">FieldVerifier</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-field-verifier/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-field-verifier/index.html">A</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-field-verifier/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">algebra<span class="token operator">: </span><a href="-field-verifier/index.html">A</a><span class="token punctuation">, </span></span><span class="parameter ">a<span class="token operator">: </span><a href="-field-verifier/index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">b<span class="token operator">: </span><a href="-field-verifier/index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">c<span class="token operator">: </span><a href="-field-verifier/index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">x<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a></span></span><span class="token punctuation">)</span> : <a href="-ring-verifier/index.html">RingVerifier</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-field-verifier/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-field-verifier/index.html">A</a><span class="token operator">&gt; </span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1837953107%2FClasslikes%2F219969693" anchor-label="RingVerifier" id="1837953107%2FClasslikes%2F219969693" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":test-utils:dokkaHtmlPartial/commonMain" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-ring-verifier/index.html"><span>Ring</span><wbr><span><span>Verifier</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1837953107%2FClasslikes%2F219969693"></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=":test-utils:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="-ring-verifier/index.html">RingVerifier</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-ring-verifier/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-ring-verifier/index.html">A</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-ring-verifier/index.html">T</a><span class="token operator">&gt;</span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-ring-verifier/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">algebra<span class="token operator">: </span><a href="-ring-verifier/index.html">A</a><span class="token punctuation">, </span></span><span class="parameter ">a<span class="token operator">: </span><a href="-ring-verifier/index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">b<span class="token operator">: </span><a href="-ring-verifier/index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">c<span class="token operator">: </span><a href="-ring-verifier/index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">x<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a></span></span><span class="token punctuation">)</span> : <a href="-space-verifier/index.html">SpaceVerifier</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-ring-verifier/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-ring-verifier/index.html">A</a><span class="token operator">&gt; </span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="216230957%2FClasslikes%2F219969693" anchor-label="SpaceVerifier" id="216230957%2FClasslikes%2F219969693" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":test-utils:dokkaHtmlPartial/commonMain" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-space-verifier/index.html"><span>Space</span><wbr><span><span>Verifier</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="216230957%2FClasslikes%2F219969693"></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=":test-utils:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="-space-verifier/index.html">SpaceVerifier</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-space-verifier/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-space-verifier/index.html">S</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-space-verifier/index.html">T</a><span class="token operator">&gt;</span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-space-verifier/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>algebra<span class="token operator">: </span><a href="-space-verifier/index.html">S</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>a<span class="token operator">: </span><a href="-space-verifier/index.html">T</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>b<span class="token operator">: </span><a href="-space-verifier/index.html">T</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>c<span class="token operator">: </span><a href="-space-verifier/index.html">T</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>x<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a></span></span><span class="token punctuation">)</span> : <a href="../../test-utils/space.kscience.kmath.testutils/-algebraic-verifier/index.html">AlgebraicVerifier</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-space-verifier/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-space-verifier/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1181779553%2FFunctions%2F219969693" anchor-label="assertBufferEquals" id="1181779553%2FFunctions%2F219969693" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":test-utils:dokkaHtmlPartial/commonMain" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="assert-buffer-equals.html"><span>assert</span><wbr><span>Buffer</span><wbr><span><span>Equals</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1181779553%2FFunctions%2F219969693"></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=":test-utils:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="assert-buffer-equals.html"><span class="token function">assertBufferEquals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">expected<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator">&lt;</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">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">result<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator">&lt;</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">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">tolerance<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator"> = </span><span class="token constant">1.0E-4</span></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-27914904%2FFunctions%2F219969693" anchor-label="contentEquals" id="-27914904%2FFunctions%2F219969693" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":test-utils:dokkaHtmlPartial/commonMain" data-filterable-set=":test-utils:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="content-equals.html"><span>content</span><wbr><span><span>Equals</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-27914904%2FFunctions%2F219969693"></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=":test-utils:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../../kmath-core/space.kscience.kmath.structures/-double-buffer/index.html">DoubleBuffer</a><span class="token punctuation">.</span><a href="content-equals.html"><span class="token function">contentEquals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>doubles<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Simplified <a href="../../kmath-core/space.kscience.kmath.structures/-double-buffer/index.html">DoubleBuffer</a> to array comparison</p></div><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation builtin">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"contentEqualsArray"</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">infix </span><span class="token keyword">fun </span><a href="../../kmath-core/space.kscience.kmath.structures/-double-buffer/index.html">DoubleBuffer</a><span class="token punctuation">.</span><a href="content-equals.html"><span class="token function">contentEquals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">otherArray<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html">DoubleArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation builtin">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"contentEqualsBuffer"</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">infix </span><span class="token keyword">fun </span><a href="../../kmath-core/space.kscience.kmath.structures/-double-buffer/index.html">DoubleBuffer</a><span class="token punctuation">.</span><a href="content-equals.html"><span class="token function">contentEquals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">otherBuffer<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.structures/-double-buffer/index.html">DoubleBuffer</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</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>