Skip to content

Commit

Permalink
deploy: 28a6288
Browse files Browse the repository at this point in the history
  • Loading branch information
@aalmada
aalmada committed Apr 10, 2024
0 parents commit 16dfa3c
Show file tree
Hide file tree
Showing 344 changed files with 99,460 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
297 changes: 297 additions & 0 deletions api/NetFabric.Numerics.Tensors.IAggregationOperator-2.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,297 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface IAggregationOperator&lt;T, TResult&gt; | NetFabric.Numerics </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IAggregationOperator&lt;T, TResult&gt; | NetFabric.Numerics ">

<meta name="description" content="Represents an aggregation operator that returns a value.">
<link rel="icon" href="../images/Logo.png">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">




<meta name="docfx:docurl" content="https://github.com/NetFabric/NetFabric.Numerics.Tensors/new/main/apiSpec/new?filename=NetFabric_Numerics_Tensors_IAggregationOperator_2.md&amp;value=---%0Auid%3A%20NetFabric.Numerics.Tensors.IAggregationOperator%602%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">

<script type="module" src="./../public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>

<script async="" src="https://www.googletagmanager.com/gtag/js?id=G-E372L91FWS"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'G-E372L91FWS');
</script>
</head>

<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/Logo.png" alt="">

</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="NetFabric.Numerics.Tensors.IAggregationOperator`2">



<h1 id="NetFabric_Numerics_Tensors_IAggregationOperator_2" data-uid="NetFabric.Numerics.Tensors.IAggregationOperator`2" class="text-break">
Interface IAggregationOperator&lt;T, TResult&gt; <a class="header-action link-secondary" title="View source" href="https://github.com/NetFabric/NetFabric.Numerics.Tensors/blob/main/src/NetFabric.Numerics.Tensors/ITensorOperation.cs/#L134"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="NetFabric.html">NetFabric</a>.<a class="xref" href="NetFabric.Numerics.html">Numerics</a>.<a class="xref" href="NetFabric.Numerics.Tensors.html">Tensors</a></dd></dl>
<dl><dt>Assembly</dt><dd>NetFabric.Numerics.Tensors.dll</dd></dl>
</div>

<div class="markdown summary"><p>Represents an aggregation operator that returns a value.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IAggregationOperator&lt;T, TResult&gt; : IBinaryOperator&lt;TResult, T, TResult&gt;, IOperator where T : struct where TResult : struct</code></pre>
</div>



<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd><p>The type of the source elements.</p>
</dd>
<dt><code>TResult</code></dt>
<dd><p>The type of the result value.</p>
</dd>
</dl>




<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="NetFabric.Numerics.Tensors.IBinaryOperator-3.html#NetFabric_Numerics_Tensors_IBinaryOperator_3_Invoke__0__1_">IBinaryOperator&lt;TResult, T, TResult&gt;.Invoke(TResult, T)</a>
</div>
<div>
<a class="xref" href="NetFabric.Numerics.Tensors.IBinaryOperator-3.html#NetFabric_Numerics_Tensors_IBinaryOperator_3_Invoke_System_Numerics_Vector__0___System_Numerics_Vector__1___">IBinaryOperator&lt;TResult, T, TResult&gt;.Invoke(ref readonly Vector&lt;TResult&gt;, ref readonly Vector&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="NetFabric.Numerics.Tensors.IOperator.html#NetFabric_Numerics_Tensors_IOperator_IsVectorizable">IOperator.IsVectorizable</a>
</div>
</dd></dl>






<h2 class="section" id="properties">Properties
</h2>


<a id="NetFabric_Numerics_Tensors_IAggregationOperator_2_Seed_" data-uid="NetFabric.Numerics.Tensors.IAggregationOperator`2.Seed*"></a>

<h3 id="NetFabric_Numerics_Tensors_IAggregationOperator_2_Seed" data-uid="NetFabric.Numerics.Tensors.IAggregationOperator`2.Seed">
Seed
<a class="header-action link-secondary" title="View source" href="https://github.com/NetFabric/NetFabric.Numerics.Tensors/blob/main/src/NetFabric.Numerics.Tensors/ITensorOperation.cs/#L143"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the seed value used to initialize the aggregation.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static TResult Seed { get; }</code></pre>
</div>





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><span class="xref">TResult</span></dt>
<dd><p>The seed value.</p>
</dd>
</dl>








<h2 class="section" id="methods">Methods
</h2>


<a id="NetFabric_Numerics_Tensors_IAggregationOperator_2_Invoke_" data-uid="NetFabric.Numerics.Tensors.IAggregationOperator`2.Invoke*"></a>

<h3 id="NetFabric_Numerics_Tensors_IAggregationOperator_2_Invoke__1_System_Numerics_Vector__1___" data-uid="NetFabric.Numerics.Tensors.IAggregationOperator`2.Invoke(`1,System.Numerics.Vector{`1}@)">
Invoke(TResult, ref readonly Vector&lt;TResult&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/NetFabric/NetFabric.Numerics.Tensors/blob/main/src/NetFabric.Numerics.Tensors/ITensorOperation.cs/#L160"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Performs the binary operation using the specified values.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static abstract TResult Invoke(TResult x, ref readonly Vector&lt;TResult&gt; y)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>x</code> <span class="xref">TResult</span></dt>
<dd><p>The first value.</p>
</dd>
<dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.vector-1">Vector</a>&lt;TResult&gt;</dt>
<dd><p>A vector of values</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">TResult</span></dt>
<dd><p>The result of using the operation.</p>
</dd>
</dl>







<h4 class="section" id="NetFabric_Numerics_Tensors_IAggregationOperator_2_Invoke__1_System_Numerics_Vector__1____remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>It's guaranteed that none of the parameters will contain NaN.</p>
</div>




<a id="NetFabric_Numerics_Tensors_IAggregationOperator_2_Invoke_" data-uid="NetFabric.Numerics.Tensors.IAggregationOperator`2.Invoke*"></a>

<h3 id="NetFabric_Numerics_Tensors_IAggregationOperator_2_Invoke__1__1_" data-uid="NetFabric.Numerics.Tensors.IAggregationOperator`2.Invoke(`1,`1)">
Invoke(TResult, TResult)
<a class="header-action link-secondary" title="View source" href="https://github.com/NetFabric/NetFabric.Numerics.Tensors/blob/main/src/NetFabric.Numerics.Tensors/ITensorOperation.cs/#L151"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Performs the binary operatorion using the specified values.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static abstract TResult Invoke(TResult x, TResult y)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>x</code> <span class="xref">TResult</span></dt>
<dd><p>The first value.</p>
</dd>
<dt><code>y</code> <span class="xref">TResult</span></dt>
<dd><p>The second value.</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">TResult</span></dt>
<dd><p>The result of using the operation.</p>
</dd>
</dl>












</article>

<div class="contribution d-print-none">
<a href="https://github.com/NetFabric/NetFabric.Numerics.Tensors/blob/main/src/NetFabric.Numerics.Tensors/ITensorOperation.cs/#L134" class="edit-link">Edit this page</a>
</div>


</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>


<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
Copyright (c) 2023-2024 Antão Almada
</div>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit 16dfa3c

Please sign in to comment.