Skip to content

Commit 764e222

Browse files
author
dotchris90
committed
Doc : Generated new doc
1 parent 9f0753e commit 764e222

28 files changed

+16402
-50
lines changed

‎docs/api/NumSharp.Core.Extensions.NDArrayExtensions.html‎

Lines changed: 317 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,317 @@
1+
<!DOCTYPE html>
2+
<!--[if IE]><![endif]-->
3+
<html>
4+
5+
<head>
6+
<meta charset="utf-8">
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8+
<title>Class NDArrayExtensions
9+
</title>
10+
<meta name="viewport" content="width=device-width">
11+
<meta name="title" content="Class NDArrayExtensions
12+
">
13+
<meta name="generator" content="docfx 2.40.2.0">
14+
15+
<link rel="shortcut icon" href="../favicon.ico">
16+
<link rel="stylesheet" href="../styles/docfx.vendor.css">
17+
<link rel="stylesheet" href="../styles/docfx.css">
18+
<link rel="stylesheet" href="../styles/main.css">
19+
<meta property="docfx:navrel" content="../toc.html">
20+
<meta property="docfx:tocrel" content="toc.html">
21+
22+
23+
24+
</head>
25+
<body data-spy="scroll" data-target="#affix" data-offset="120">
26+
<div id="wrapper">
27+
<header>
28+
29+
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
30+
<div class="container">
31+
<div class="navbar-header">
32+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
33+
<span class="sr-only">Toggle navigation</span>
34+
<span class="icon-bar"></span>
35+
<span class="icon-bar"></span>
36+
<span class="icon-bar"></span>
37+
</button>
38+
39+
<a class="navbar-brand" href="../index.html">
40+
<img id="logo" class="svg" src="../logo.svg" alt="">
41+
</a>
42+
</div>
43+
<div class="collapse navbar-collapse" id="navbar">
44+
<form class="navbar-form navbar-right" role="search" id="search">
45+
<div class="form-group">
46+
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
47+
</div>
48+
</form>
49+
</div>
50+
</div>
51+
</nav>
52+
53+
<div class="subnav navbar navbar-default">
54+
<div class="container hide-when-search" id="breadcrumb">
55+
<ul class="breadcrumb">
56+
<li></li>
57+
</ul>
58+
</div>
59+
</div>
60+
</header>
61+
<div role="main" class="container body-content hide-when-search">
62+
63+
<div class="sidenav hide-when-search">
64+
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
65+
<div class="sidetoggle collapse" id="sidetoggle">
66+
<div id="sidetoc"></div>
67+
</div>
68+
</div>
69+
<div class="article row grid-right">
70+
<div class="col-md-10">
71+
<article class="content wrap" id="_content" data-uid="NumSharp.Core.Extensions.NDArrayExtensions">
72+
73+
74+
<h1 id="NumSharp_Core_Extensions_NDArrayExtensions" data-uid="NumSharp.Core.Extensions.NDArrayExtensions" class="text-break">Class NDArrayExtensions
75+
</h1>
76+
<div class="markdown level0 summary"></div>
77+
<div class="markdown level0 conceptual"></div>
78+
<div class="inheritance">
79+
<h5>Inheritance</h5>
80+
<div class="level0"><span class="xref">System.Object</span></div>
81+
<div class="level1"><span class="xref">NDArrayExtensions</span></div>
82+
</div>
83+
<div class="inheritedMembers">
84+
<h5>Inherited Members</h5>
85+
<div>
86+
<span class="xref">System.Object.Equals(System.Object)</span>
87+
</div>
88+
<div>
89+
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
90+
</div>
91+
<div>
92+
<span class="xref">System.Object.GetHashCode()</span>
93+
</div>
94+
<div>
95+
<span class="xref">System.Object.GetType()</span>
96+
</div>
97+
<div>
98+
<span class="xref">System.Object.MemberwiseClone()</span>
99+
</div>
100+
<div>
101+
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
102+
</div>
103+
<div>
104+
<span class="xref">System.Object.ToString()</span>
105+
</div>
106+
</div>
107+
<h6><strong>Namespace</strong>: <a class="xref" href="NumSharp.Core.Extensions.html">NumSharp.Core.Extensions</a></h6>
108+
<h6><strong>Assembly</strong>: NumSharp.Core.dll</h6>
109+
<h5 id="NumSharp_Core_Extensions_NDArrayExtensions_syntax">Syntax</h5>
110+
<div class="codewrapper">
111+
<pre><code class="lang-csharp hljs">public static class NDArrayExtensions</code></pre>
112+
</div>
113+
<h3 id="methods">Methods
114+
</h3>
115+
<span class="small pull-right mobile-hide">
116+
<span class="divider">|</span>
117+
<a href="https://github.com/dotChris90/NumSharp/new/master/apiSpec/new?filename=NumSharp_Core_Extensions_NDArrayExtensions_ArgMax__1_NumSharp_Core_NDArray_.md&amp;value=---%0Auid%3A%20NumSharp.Core.Extensions.NDArrayExtensions.ArgMax%60%601(NumSharp.Core.NDArray)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
118+
</span>
119+
<span class="small pull-right mobile-hide">
120+
<a href="https://github.com/dotChris90/NumSharp/blob/master/src/NumSharp.Core/Extensions/NdArray.ArgMax.cs/#L10">View Source</a>
121+
</span>
122+
<a id="NumSharp_Core_Extensions_NDArrayExtensions_ArgMax_" data-uid="NumSharp.Core.Extensions.NDArrayExtensions.ArgMax*"></a>
123+
<h4 id="NumSharp_Core_Extensions_NDArrayExtensions_ArgMax__1_NumSharp_Core_NDArray_" data-uid="NumSharp.Core.Extensions.NDArrayExtensions.ArgMax``1(NumSharp.Core.NDArray)">ArgMax&lt;T&gt;(NDArray)</h4>
124+
<div class="markdown level1 summary"></div>
125+
<div class="markdown level1 conceptual"></div>
126+
<h5 class="decalaration">Declaration</h5>
127+
<div class="codewrapper">
128+
<pre><code class="lang-csharp hljs">public static int ArgMax&lt;T&gt;(this NDArray np)</code></pre>
129+
</div>
130+
<h5 class="parameters">Parameters</h5>
131+
<table class="table table-bordered table-striped table-condensed">
132+
<thead>
133+
<tr>
134+
<th>Type</th>
135+
<th>Name</th>
136+
<th>Description</th>
137+
</tr>
138+
</thead>
139+
<tbody>
140+
<tr>
141+
<td><a class="xref" href="NumSharp.Core.NDArray.html">NDArray</a></td>
142+
<td><span class="parametername">np</span></td>
143+
<td></td>
144+
</tr>
145+
</tbody>
146+
</table>
147+
<h5 class="returns">Returns</h5>
148+
<table class="table table-bordered table-striped table-condensed">
149+
<thead>
150+
<tr>
151+
<th>Type</th>
152+
<th>Description</th>
153+
</tr>
154+
</thead>
155+
<tbody>
156+
<tr>
157+
<td><span class="xref">System.Int32</span></td>
158+
<td></td>
159+
</tr>
160+
</tbody>
161+
</table>
162+
<h5 class="typeParameters">Type Parameters</h5>
163+
<table class="table table-bordered table-striped table-condensed">
164+
<thead>
165+
<tr>
166+
<th>Name</th>
167+
<th>Description</th>
168+
</tr>
169+
</thead>
170+
<tbody>
171+
<tr>
172+
<td><span class="parametername">T</span></td>
173+
<td></td>
174+
</tr>
175+
</tbody>
176+
</table>
177+
<span class="small pull-right mobile-hide">
178+
<span class="divider">|</span>
179+
<a href="https://github.com/dotChris90/NumSharp/new/master/apiSpec/new?filename=NumSharp_Core_Extensions_NDArrayExtensions_AsMatrix_NumSharp_Core_NDArray_.md&amp;value=---%0Auid%3A%20NumSharp.Core.Extensions.NDArrayExtensions.AsMatrix(NumSharp.Core.NDArray)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
180+
</span>
181+
<span class="small pull-right mobile-hide">
182+
<a href="https://github.com/dotChris90/NumSharp/blob/master/src/NumSharp.Core/Creation/NdArray.AsMatrix.cs/#L11">View Source</a>
183+
</span>
184+
<a id="NumSharp_Core_Extensions_NDArrayExtensions_AsMatrix_" data-uid="NumSharp.Core.Extensions.NDArrayExtensions.AsMatrix*"></a>
185+
<h4 id="NumSharp_Core_Extensions_NDArrayExtensions_AsMatrix_NumSharp_Core_NDArray_" data-uid="NumSharp.Core.Extensions.NDArrayExtensions.AsMatrix(NumSharp.Core.NDArray)">AsMatrix(NDArray)</h4>
186+
<div class="markdown level1 summary"></div>
187+
<div class="markdown level1 conceptual"></div>
188+
<h5 class="decalaration">Declaration</h5>
189+
<div class="codewrapper">
190+
<pre><code class="lang-csharp hljs">public static matrix AsMatrix(this NDArray nd)</code></pre>
191+
</div>
192+
<h5 class="parameters">Parameters</h5>
193+
<table class="table table-bordered table-striped table-condensed">
194+
<thead>
195+
<tr>
196+
<th>Type</th>
197+
<th>Name</th>
198+
<th>Description</th>
199+
</tr>
200+
</thead>
201+
<tbody>
202+
<tr>
203+
<td><a class="xref" href="NumSharp.Core.NDArray.html">NDArray</a></td>
204+
<td><span class="parametername">nd</span></td>
205+
<td></td>
206+
</tr>
207+
</tbody>
208+
</table>
209+
<h5 class="returns">Returns</h5>
210+
<table class="table table-bordered table-striped table-condensed">
211+
<thead>
212+
<tr>
213+
<th>Type</th>
214+
<th>Description</th>
215+
</tr>
216+
</thead>
217+
<tbody>
218+
<tr>
219+
<td><a class="xref" href="NumSharp.Core.matrix.html">matrix</a></td>
220+
<td></td>
221+
</tr>
222+
</tbody>
223+
</table>
224+
<span class="small pull-right mobile-hide">
225+
<span class="divider">|</span>
226+
<a href="https://github.com/dotChris90/NumSharp/new/master/apiSpec/new?filename=NumSharp_Core_Extensions_NDArrayExtensions_mean_NumSharp_Core_NDArray_System_Int32_.md&amp;value=---%0Auid%3A%20NumSharp.Core.Extensions.NDArrayExtensions.mean(NumSharp.Core.NDArray%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
227+
</span>
228+
<span class="small pull-right mobile-hide">
229+
<a href="https://github.com/dotChris90/NumSharp/blob/master/src/NumSharp.Core/Math/NdArray.Mean.cs/#L10">View Source</a>
230+
</span>
231+
<a id="NumSharp_Core_Extensions_NDArrayExtensions_mean_" data-uid="NumSharp.Core.Extensions.NDArrayExtensions.mean*"></a>
232+
<h4 id="NumSharp_Core_Extensions_NDArrayExtensions_mean_NumSharp_Core_NDArray_System_Int32_" data-uid="NumSharp.Core.Extensions.NDArrayExtensions.mean(NumSharp.Core.NDArray,System.Int32)">mean(NDArray, Int32)</h4>
233+
<div class="markdown level1 summary"></div>
234+
<div class="markdown level1 conceptual"></div>
235+
<h5 class="decalaration">Declaration</h5>
236+
<div class="codewrapper">
237+
<pre><code class="lang-csharp hljs">public static NDArray mean(this NDArray np, int axis = -1)</code></pre>
238+
</div>
239+
<h5 class="parameters">Parameters</h5>
240+
<table class="table table-bordered table-striped table-condensed">
241+
<thead>
242+
<tr>
243+
<th>Type</th>
244+
<th>Name</th>
245+
<th>Description</th>
246+
</tr>
247+
</thead>
248+
<tbody>
249+
<tr>
250+
<td><a class="xref" href="NumSharp.Core.NDArray.html">NDArray</a></td>
251+
<td><span class="parametername">np</span></td>
252+
<td></td>
253+
</tr>
254+
<tr>
255+
<td><span class="xref">System.Int32</span></td>
256+
<td><span class="parametername">axis</span></td>
257+
<td></td>
258+
</tr>
259+
</tbody>
260+
</table>
261+
<h5 class="returns">Returns</h5>
262+
<table class="table table-bordered table-striped table-condensed">
263+
<thead>
264+
<tr>
265+
<th>Type</th>
266+
<th>Description</th>
267+
</tr>
268+
</thead>
269+
<tbody>
270+
<tr>
271+
<td><a class="xref" href="NumSharp.Core.NDArray.html">NDArray</a></td>
272+
<td></td>
273+
</tr>
274+
</tbody>
275+
</table>
276+
</article>
277+
</div>
278+
279+
<div class="hidden-sm col-md-2" role="complementary">
280+
<div class="sideaffix">
281+
<div class="contribution">
282+
<ul class="nav">
283+
<li>
284+
<a href="https://github.com/dotChris90/NumSharp/new/master/apiSpec/new?filename=NumSharp_Core_Extensions_NDArrayExtensions.md&amp;value=---%0Auid%3A%20NumSharp.Core.Extensions.NDArrayExtensions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
285+
</li>
286+
<li>
287+
<a href="https://github.com/dotChris90/NumSharp/blob/master/src/NumSharp.Core/Math/NdArray.Mean.cs/#L8" class="contribution-link">View Source</a>
288+
</li>
289+
</ul>
290+
</div>
291+
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
292+
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
293+
</nav>
294+
</div>
295+
</div>
296+
</div>
297+
</div>
298+
299+
<footer>
300+
<div class="grad-bottom"></div>
301+
<div class="footer">
302+
<div class="container">
303+
<span class="pull-right">
304+
<a href="#top">Back to top</a>
305+
</span>
306+
307+
<span>Generated by <strong>DocFX</strong></span>
308+
</div>
309+
</div>
310+
</footer>
311+
</div>
312+
313+
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
314+
<script type="text/javascript" src="../styles/docfx.js"></script>
315+
<script type="text/javascript" src="../styles/main.js"></script>
316+
</body>
317+
</html>

0 commit comments

Comments
 (0)