Skip to content

Commit d17687d

Browse files
sayantnAmanieu
authored andcommitted
Fix Documentation
1 parent 059a2e0 commit d17687d

File tree

13 files changed

+175
-133
lines changed

13 files changed

+175
-133
lines changed

crates/core_arch/src/x86/adx.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ extern "unadjusted" {
1414
/// Adds unsigned 32-bit integers `a` and `b` with unsigned 8-bit carry-in `c_in`
1515
/// (carry or overflow flag), and store the unsigned 32-bit result in `out`, and the carry-out
1616
/// is returned (carry or overflow flag).
17+
///
18+
/// [Intel's documentation](https://software.intel.com/sites/landingpage/IntrinsicsGuide/#text=_addcarry_u32)
1719
#[inline]
1820
#[cfg_attr(test, assert_instr(adc))]
1921
#[stable(feature = "simd_x86_adx", since = "1.33.0")]
@@ -26,6 +28,8 @@ pub unsafe fn _addcarry_u32(c_in: u8, a: u32, b: u32, out: &mut u32) -> u8 {
2628
/// Adds unsigned 32-bit integers `a` and `b` with unsigned 8-bit carry-in `c_in`
2729
/// (carry or overflow flag), and store the unsigned 32-bit result in `out`, and
2830
/// the carry-out is returned (carry or overflow flag).
31+
///
32+
/// [Intel's documentation](https://software.intel.com/sites/landingpage/IntrinsicsGuide/#text=_addcarryx_u32)
2933
#[inline]
3034
#[target_feature(enable = "adx")]
3135
#[cfg_attr(test, assert_instr(adc))]
@@ -37,6 +41,8 @@ pub unsafe fn _addcarryx_u32(c_in: u8, a: u32, b: u32, out: &mut u32) -> u8 {
3741
/// Adds unsigned 32-bit integers `a` and `b` with unsigned 8-bit carry-in `c_in`
3842
/// (carry or overflow flag), and store the unsigned 32-bit result in `out`, and
3943
/// the carry-out is returned (carry or overflow flag).
44+
///
45+
/// [Intel's documentation](https://software.intel.com/sites/landingpage/IntrinsicsGuide/#text=_subborrow_u32)
4046
#[inline]
4147
#[cfg_attr(test, assert_instr(sbb))]
4248
#[stable(feature = "simd_x86_adx", since = "1.33.0")]

crates/core_arch/src/x86/avx512bw.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ pub unsafe fn _mm512_maskz_add_epi16(k: __mmask32, a: __m512i, b: __m512i) -> __
222222

223223
/// Add packed 16-bit integers in a and b, and store the results in dst using writemask k (elements are copied from src when the corresponding mask bit is not set).
224224
///
225-
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm256_mask_add_epi&expand=89)
225+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm256_mask_add_epi16&expand=89)
226226
#[inline]
227227
#[target_feature(enable = "avx512bw,avx512vl")]
228228
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]
@@ -2328,7 +2328,7 @@ pub unsafe fn _mm_maskz_min_epi8(k: __mmask16, a: __m128i, b: __m128i) -> __m128
23282328

23292329
/// Compare packed unsigned 16-bit integers in a and b for less-than, and store the results in mask vector k.
23302330
///
2331-
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=512_cmplt_epu16_mask&expand=1050)
2331+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_cmplt_epu16_mask&expand=1050)
23322332
#[inline]
23332333
#[target_feature(enable = "avx512bw")]
23342334
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]
@@ -2350,7 +2350,7 @@ pub unsafe fn _mm512_mask_cmplt_epu16_mask(k1: __mmask32, a: __m512i, b: __m512i
23502350

23512351
/// Compare packed unsigned 16-bit integers in a and b for less-than, and store the results in mask vector k.
23522352
///
2353-
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=512_cmplt_epu16_mask&expand=1050)
2353+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm256_cmplt_epu16_mask&expand=1050)
23542354
#[inline]
23552355
#[target_feature(enable = "avx512bw,avx512vl")]
23562356
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]
@@ -2372,7 +2372,7 @@ pub unsafe fn _mm256_mask_cmplt_epu16_mask(k1: __mmask16, a: __m256i, b: __m256i
23722372

23732373
/// Compare packed unsigned 16-bit integers in a and b for less-than, and store the results in mask vector k.
23742374
///
2375-
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_cmplt_epi16_mask&expand=1018)
2375+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_cmplt_epu16_mask&expand=1018)
23762376
#[inline]
23772377
#[target_feature(enable = "avx512bw,avx512vl")]
23782378
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]
@@ -2383,7 +2383,7 @@ pub unsafe fn _mm_cmplt_epu16_mask(a: __m128i, b: __m128i) -> __mmask8 {
23832383

23842384
/// Compare packed unsigned 16-bit integers in a and b for less-than, and store the results in mask vector k using zeromask k1 (elements are zeroed out when the corresponding mask bit is not set).
23852385
///
2386-
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_mask_cmplt_epi16_mask&expand=1019)
2386+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_mask_cmplt_epu16_mask&expand=1019)
23872387
#[inline]
23882388
#[target_feature(enable = "avx512bw,avx512vl")]
23892389
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]
@@ -9316,7 +9316,7 @@ pub unsafe fn _mm512_mask_test_epi16_mask(k: __mmask32, a: __m512i, b: __m512i)
93169316

93179317
/// Compute the bitwise AND of packed 16-bit integers in a and b, producing intermediate 16-bit values, and set the corresponding bit in result mask k if the intermediate value is non-zero.
93189318
///
9319-
// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm256_test_epi16_mask&expand=5882)
9319+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm256_test_epi16_mask&expand=5882)
93209320
#[inline]
93219321
#[target_feature(enable = "avx512bw,avx512vl")]
93229322
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]
@@ -9342,7 +9342,7 @@ pub unsafe fn _mm256_mask_test_epi16_mask(k: __mmask16, a: __m256i, b: __m256i)
93429342

93439343
/// Compute the bitwise AND of packed 16-bit integers in a and b, producing intermediate 16-bit values, and set the corresponding bit in result mask k if the intermediate value is non-zero.
93449344
///
9345-
// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_test_epi16_mask&expand=5880)
9345+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_test_epi16_mask&expand=5880)
93469346
#[inline]
93479347
#[target_feature(enable = "avx512bw,avx512vl")]
93489348
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]
@@ -9459,7 +9459,7 @@ pub unsafe fn _mm512_testn_epi16_mask(a: __m512i, b: __m512i) -> __mmask32 {
94599459

94609460
/// Compute the bitwise NAND of packed 16-bit integers in a and b, producing intermediate 16-bit values, and set the corresponding bit in result mask k (subject to writemask k) if the intermediate value is zero.
94619461
///
9462-
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_mask_testn_epi16&expand=5914)
9462+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_mask_testn_epi16_mask&expand=5914)
94639463
#[inline]
94649464
#[target_feature(enable = "avx512bw")]
94659465
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]
@@ -10397,7 +10397,7 @@ pub unsafe fn _ktestz_mask64_u8(a: __mmask64, b: __mmask64) -> u8 {
1039710397

1039810398
/// Unpack and interleave 16 bits from masks a and b, and store the 32-bit result in k.
1039910399
///
10400-
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=512_kunpackw)
10400+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_kunpackw)
1040110401
#[inline]
1040210402
#[target_feature(enable = "avx512bw")]
1040310403
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]
@@ -10408,7 +10408,7 @@ pub unsafe fn _mm512_kunpackw(a: __mmask32, b: __mmask32) -> __mmask32 {
1040810408

1040910409
/// Unpack and interleave 32 bits from masks a and b, and store the 64-bit result in k.
1041010410
///
10411-
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=512_kunpackd)
10411+
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_kunpackd)
1041210412
#[inline]
1041310413
#[target_feature(enable = "avx512bw")]
1041410414
#[unstable(feature = "stdarch_x86_avx512", issue = "111137")]

crates/core_arch/src/x86/avx512dq.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ pub unsafe fn _mm256_maskz_and_pd(k: __mmask8, a: __m256d, b: __m256d) -> __m256
6565
/// Compute the bitwise AND of packed double-precision (64-bit) floating point numbers in a and b
6666
/// and store the results in dst.
6767
///
68-
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_mask_and_pd&ig_expand=293)
68+
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_and_pd&ig_expand=293)
6969
#[inline]
7070
#[target_feature(enable = "avx512dq")]
7171
#[cfg_attr(test, assert_instr(vandp))]
@@ -3760,7 +3760,7 @@ pub unsafe fn _mm512_maskz_cvttps_epi64(k: __mmask8, a: __m256) -> __m512i {
37603760
/// with truncation, and store the result in dst. Exceptions can be suppressed by passing _MM_FROUND_NO_EXC
37613761
/// to the sae parameter.
37623762
///
3763-
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_cvtpd_epu64&ig_expand=1965)
3763+
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_cvtt_roundpd_epu64&ig_expand=1965)
37643764
#[inline]
37653765
#[target_feature(enable = "avx512dq")]
37663766
#[cfg_attr(test, assert_instr(vcvttpd2uqq, SAE = 8))]
@@ -5209,7 +5209,7 @@ pub unsafe fn _mm512_maskz_range_ps<const IMM8: i32>(k: __mmask16, a: __m512, b:
52095209
/// 00 = sign from a, 01 = sign from compare result, 10 = clear sign bit, 11 = set sign bit.
52105210
/// Exceptions can be suppressed by passing _MM_FROUND_NO_EXC in the sae parameter.
52115211
///
5212-
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_range_round_sd&ig_expand=5216)
5212+
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_range_round_sd&ig_expand=5216)
52135213
#[inline]
52145214
#[target_feature(enable = "avx512dq")]
52155215
#[cfg_attr(test, assert_instr(vrangesd, IMM8 = 5, SAE = 8))]
@@ -5345,7 +5345,7 @@ pub unsafe fn _mm_maskz_range_sd<const IMM8: i32>(k: __mmask8, a: __m128d, b: __
53455345
/// 00 = sign from a, 01 = sign from compare result, 10 = clear sign bit, 11 = set sign bit.
53465346
/// Exceptions can be suppressed by passing _MM_FROUND_NO_EXC in the sae parameter.
53475347
///
5348-
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm512_range_round_ss&ig_expand=5219)
5348+
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_range_round_ss&ig_expand=5219)
53495349
#[inline]
53505350
#[target_feature(enable = "avx512dq")]
53515351
#[cfg_attr(test, assert_instr(vrangess, IMM8 = 5, SAE = 8))]
@@ -6743,7 +6743,7 @@ pub unsafe fn _mm512_mask_fpclass_ps_mask<const IMM8: i32>(k1: __mmask16, a: __m
67436743
/// - 0x40 // Negative
67446744
/// - 0x80 // SNaN
67456745
///
6746-
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_maskz_fpclass_sd_mask&ig_expand=3511)
6746+
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_fpclass_sd_mask&ig_expand=3511)
67476747
#[inline]
67486748
#[target_feature(enable = "sse,avx512f,avx512dq")]
67496749
#[cfg_attr(test, assert_instr(vfpclasssd, IMM8 = 0))]
@@ -6792,7 +6792,7 @@ pub unsafe fn _mm_mask_fpclass_sd_mask<const IMM8: i32>(k1: __mmask8, a: __m128d
67926792
/// - 0x40 // Negative
67936793
/// - 0x80 // SNaN
67946794
///
6795-
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_maskz_fpclass_ss_mask&ig_expand=3515)
6795+
/// [Intel's Documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_fpclass_ss_mask&ig_expand=3515)
67966796
#[inline]
67976797
#[target_feature(enable = "sse,avx512f,avx512dq")]
67986798
#[cfg_attr(test, assert_instr(vfpclassss, IMM8 = 0))]

0 commit comments

Comments
 (0)