Skip to content

Port System.Numerics.Tensors source comments to Docs #2323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Port System.Numerics.Tensors source comments to Docs #2323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 57 additions & 57 deletions xml/System.Numerics.Tensors/ArrayTensorExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@
<Parameter Name="array" Type="T[]" RefType="this" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/>.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/> from.</param>
<summary>Creates a copy of this single-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/>.</summary>
<returns>A 1-dimensional <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/> with the same length and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -68,11 +68,11 @@
<Parameter Name="reverseStride" Type="System.Boolean" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<param name="reverseStride">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/>.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/> from.</param>
<param name="reverseStride"><see langword="false" /> (default) to indicate that the first dimension is most major (farthest apart) and the last dimension is most minor (closest together): akin to row-major in a rank-2 tensor. <see langword="true" /> to indicate that the last dimension is most major (farthest apart) and the first dimension is most minor (closest together): akin to column-major in a rank-2 tensor.</param>
<summary>Creates a copy of this n-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/>.</summary>
<returns>A n-dimensional <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/> with the same dimensions and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -98,11 +98,11 @@
<Parameter Name="reverseStride" Type="System.Boolean" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<param name="reverseStride">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/>.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/> from.</param>
<param name="reverseStride"><see langword="false" /> (default) to indicate that the first dimension is most major (farthest apart) and the last dimension is most minor (closest together): akin to row-major in a rank-2 tensor. <see langword="true" /> to indicate that the last dimension is most major (farthest apart) and the first dimension is most minor (closest together): akin to column-major in a rank-2 tensor.</param>
<summary>Creates a copy of this three-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/>.</summary>
<returns>A 3-dimensional <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/> with the same dimensions and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -128,11 +128,11 @@
<Parameter Name="reverseStride" Type="System.Boolean" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<param name="reverseStride">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/>.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/> from.</param>
<param name="reverseStride"><see langword="false" /> (default) to indicate that the first dimension is most major (farthest apart) and the last dimension is most minor (closest together): row-major. <see langword="true" /> to indicate that the last dimension is most major (farthest apart) and the first dimension is most minor (closest together): column-major.</param>
<summary>Creates a copy of this two-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/>.</summary>
<returns>A 2-dimensional <see cref="T:System.Numerics.Tensors.CompressedSparseTensor`1"/> with the same dimensions and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -158,10 +158,10 @@
<Parameter Name="array" Type="T[]" RefType="this" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" />.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" /> from.</param>
<summary>Creates a copy of this single-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" />.</summary>
<returns>A 1-dimensional <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" /> with the same length and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -186,11 +186,11 @@
<Parameter Name="reverseStride" Type="System.Boolean" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<param name="reverseStride">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" />.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" /> from.</param>
<param name="reverseStride"><see langword="false" /> (default) to indicate that the first dimension is most major (farthest apart) and the last dimension is most minor (closest together): akin to row-major in a rank-2 tensor. <see langword="true" /> to indicate that the last dimension is most major (farthest apart) and the first dimension is most minor (closest together): akin to column-major in a rank-2 tensor.</param>
<summary>Creates a copy of this n-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" />.</summary>
<returns>A n-dimensional <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" /> with the same dimensions and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -216,11 +216,11 @@
<Parameter Name="reverseStride" Type="System.Boolean" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<param name="reverseStride">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" />.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" /> from.</param>
<param name="reverseStride"><see langword="false" /> (default) to indicate that the first dimension is most major (farthest apart) and the last dimension is most minor (closest together): akin to row-major in a rank-2 tensor. <see langword="true" /> to indicate that the last dimension is most major (farthest apart) and the first dimension is most minor (closest together): akin to column-major in a rank-2 tensor.</param>
<summary>Creates a copy of this three-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" />.</summary>
<returns>A 3-dimensional <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" /> with the same dimensions and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -246,11 +246,11 @@
<Parameter Name="reverseStride" Type="System.Boolean" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<param name="reverseStride">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" />.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" /> from.</param>
<param name="reverseStride"><see langword="false" /> (default) to indicate that the first dimension is most major (farthest apart) and the last dimension is most minor (closest together): row-major. <see langword="true" /> to indicate that the last dimension is most major (farthest apart) and the first dimension is most minor (closest together): column-major.</param>
<summary>Creates a copy of this two-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" />.</summary>
<returns>A 2-dimensional <see cref="T:System.Numerics.Tensors.SparseTensor&lt;T&gt;" /> with the same dimensions and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -276,10 +276,10 @@
<Parameter Name="array" Type="T[]" RefType="this" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" />.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" /> from.</param>
<summary>Creates a copy of this single-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" />.</summary>
<returns>A 1-dimensional <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" /> with the same length and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -304,11 +304,11 @@
<Parameter Name="reverseStride" Type="System.Boolean" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<param name="reverseStride">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" />.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" /> from.</param>
<param name="reverseStride"><see langword="false" /> (default) to indicate that the first dimension is most major (farthest apart) and the last dimension is most minor (closest together): akin to row-major in a rank-2 tensor. <see langword="true" /> to indicate that the last dimension is most major (farthest apart) and the first dimension is most minor (closest together): akin to column-major in a rank-2 tensor.</param>
<summary>Creates a copy of this n-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" /></summary>
<returns>A n-dimensional <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" /> with the same dimensions and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -334,11 +334,11 @@
<Parameter Name="reverseStride" Type="System.Boolean" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<param name="reverseStride">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" />.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" /> from.</param>
<param name="reverseStride"><see langword="false" /> (default) to indicate that the first dimension is most major (farthest apart) and the last dimension is most minor (closest together): akin to row-major in a rank-2 tensor. <see langword="true" /> to indicate that the last dimension is most major (farthest apart) and the first dimension is most minor (closest together): akin to column-major in a rank-2 tensor.</param>
<summary>Creates a copy of this three-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" />.</summary>
<returns>A 3-dimensional <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" /> with the same dimensions and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -364,11 +364,11 @@
<Parameter Name="reverseStride" Type="System.Boolean" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="array">To be added.</param>
<param name="reverseStride">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">Type contained in the <paramref name="array" /> to copy to the <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" />.</typeparam>
<param name="array">The array to create a <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" /> from.</param>
<param name="reverseStride"><see langword="false" /> (default) to indicate that the first dimension is most major (farthest apart) and the last dimension is most minor (closest together): row-major. <see langword="true" /> to indicate that the last dimension is most major (farthest apart) and the first dimension is most minor (closest together): column-major.</param>
<summary>Creates a copy of this two-dimensional <paramref name="array" /> as a <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" />.</summary>
<returns>A 2-dimensional <see cref="T:System.Numerics.Tensors.DenseTensor&lt;T&gt;" /> with the same dimensions and content as <paramref name="array" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Loading