Automatically port System.Runtime.Intrinsics.X86 triple slash comments #3095
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <Type Name="Avx2" FullName="System.Runtime.Intrinsics.X86.Avx2"> | ||
| <TypeSignature Language="C#" Value="public abstract class Avx2 : System.Runtime.Intrinsics.X86.Avx" /> | ||
| <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Avx2 extends System.Runtime.Intrinsics.X86.Avx" /> | ||
| <TypeSignature Language="DocId" Value="T:System.Runtime.Intrinsics.X86.Avx2" /> | ||
|
|
@@ -3617,7 +3617,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVZXBW ymm, m128</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3642,7 +3652,10 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="value">To be added.</param> | ||
| <summary> | ||
| __m256i _mm256_cvtepu8_epi16 (__m128i a) | ||
|
There was a problem hiding this comment. Will this render as two separate lines? There was a problem hiding this comment. I don't think so, but if you look at other pre-existing summaries in this file, they have the exact same format: an endline at the beginning. There was a problem hiding this comment. Actually, Docs doesn't seem to respect the endline in the middle. Take Avx.ConvertToVector256Int32 for example: There was a problem hiding this comment. At first I was assuming you were talking about lines 3655 and 3656, but the problem applies for both cases I mentioned above. There was a problem hiding this comment. That's unfortunate; is there a way to ensure that the newline is retained? There was a problem hiding this comment. Just asking for this case in particular. Ideally it would render as two separate lines; since the native instruction (second line) and the C++ intrinsic (first line) should be differentiated here. There was a problem hiding this comment. There are two things to try:
There was a problem hiding this comment. I think you need <para> tags to render as two lines. There was a problem hiding this comment. I only have experience with There was a problem hiding this comment. I did an example here: ea2cac4 |
||
| VPMOVZXBW ymm, xmm | ||
| </summary> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3698,7 +3711,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVSXBW ymm, m128</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3722,7 +3745,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVZXBD ymm, m64</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3746,7 +3779,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVSXWD ymm, m128</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3771,7 +3814,10 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="value">To be added.</param> | ||
| <summary> | ||
| __m256i _mm256_cvtepu8_epi32 (__m128i a) | ||
| VPMOVZXBD ymm, xmm | ||
| </summary> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3860,7 +3906,10 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="value">To be added.</param> | ||
| <summary> | ||
| __m256i _mm256_cvtepu16_epi32 (__m128i a) | ||
| VPMOVZXWD ymm, xmm | ||
| </summary> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3884,7 +3933,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVSXBD ymm, m64</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3908,7 +3967,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVZXWD ymm, m128</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3932,7 +4001,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVZXBQ ymm, m32</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3956,7 +4035,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVSXWQ ymm, m64</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -3980,7 +4069,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVSXDQ ymm, m128</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -4005,7 +4104,10 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="value">To be added.</param> | ||
| <summary> | ||
| __m256i _mm256_cvtepu8_epi64 (__m128i a) | ||
| VPMOVZXBQ ymm, xmm | ||
| </summary> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -4126,7 +4228,10 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="value">To be added.</param> | ||
| <summary> | ||
| __m256i _mm256_cvtepu16_epi64 (__m128i a) | ||
| VPMOVZXWQ ymm, xmm | ||
| </summary> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -4151,7 +4256,10 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="value">To be added.</param> | ||
| <summary> | ||
| __m256i _mm256_cvtepu32_epi64 (__m128i a) | ||
| VPMOVZXDQ ymm, xmm | ||
| </summary> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -4175,7 +4283,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVSXBQ ymm, m32</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -4199,7 +4317,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVZXWQ ymm, m64</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
@@ -4223,7 +4351,17 @@ | |
| </Parameters> | ||
| <Docs> | ||
| <param name="address">To be added.</param> | ||
| <summary>VPMOVZXDQ ymm, m128</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks> | ||
| <format type="text/markdown"><![CDATA[ | ||
|
|
||
| ## Remarks | ||
|
|
||
| The native signature does not exist. We provide this additional overload for completeness. | ||
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> | ||
| </Docs> | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion to remove we from the sentence. If accepted, should be applied everywhere.
Also, will customers know what this means?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I applied the change. @tannergooding @CarolEidt, if a customer that is familiar with these APIs going to understand remarks like this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I believe they will. The point is that, while most of these map to "native" C++ intrinsics, some do not. For example, these take an address (pointer), since the instruction supports an in-memory operand. The C++ intrinsics don't provide those as distinct overloads.