Skip to content

Commit 5decf65

Browse files
marxinmarxin
committed
Provide link for rounding parameters - SSE
1 parent 89fb13f commit 5decf65

File tree

1 file changed

+20
-96
lines changed

1 file changed

+20
-96
lines changed

‎crates/core_arch/src/x86/sse41.rs‎

Lines changed: 20 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -740,30 +740,11 @@ pub unsafe fn _mm_ceil_ss(a: __m128, b: __m128) -> __m128 {
740740
/// double-precision floating-point elements.
741741
/// Rounding is done according to the rounding parameter, which can be one of:
742742
///
743-
/// ```
744-
/// #[cfg(target_arch = "x86")]
745-
/// use std::arch::x86::*;
746-
/// #[cfg(target_arch = "x86_64")]
747-
/// use std::arch::x86_64::*;
748-
///
749-
/// # fn main() {
750-
/// // round to nearest, and suppress exceptions:
751-
/// # let _x =
752-
/// _MM_FROUND_TO_NEAREST_INT | _MM_FROUND_NO_EXC;
753-
/// // round down, and suppress exceptions:
754-
/// # let _x =
755-
/// _MM_FROUND_TO_NEG_INF | _MM_FROUND_NO_EXC;
756-
/// // round up, and suppress exceptions:
757-
/// # let _x =
758-
/// _MM_FROUND_TO_POS_INF | _MM_FROUND_NO_EXC;
759-
/// // truncate, and suppress exceptions:
760-
/// # let _x =
761-
/// _MM_FROUND_TO_ZERO | _MM_FROUND_NO_EXC;
762-
/// // use MXCSR.RC; see `_MM_SET_ROUNDING_MODE`:
763-
/// # let _x =
764-
/// _MM_FROUND_CUR_DIRECTION;
765-
/// # }
766-
/// ```
743+
/// * [`_MM_FROUND_TO_NEAREST_INT`] | [`_MM_FROUND_NO_EXC`]: round to nearest and suppress exceptions
744+
/// * [`_MM_FROUND_TO_NEG_INF`] | [`_MM_FROUND_NO_EXC`]: round down and suppress exceptions
745+
/// * [`_MM_FROUND_TO_POS_INF`] | [`_MM_FROUND_NO_EXC`]: round up and suppress exceptions
746+
/// * [`_MM_FROUND_TO_ZERO`] | [`_MM_FROUND_NO_EXC`]: truncate and suppress exceptions
747+
/// * [`_MM_FROUND_CUR_DIRECTION`]: use `MXCSR.RC` - see [`_MM_SET_ROUNDING_MODE`]
767748
///
768749
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_round_pd)
769750
#[inline]
@@ -781,30 +762,11 @@ pub unsafe fn _mm_round_pd<const ROUNDING: i32>(a: __m128d) -> __m128d {
781762
/// single-precision floating-point elements.
782763
/// Rounding is done according to the rounding parameter, which can be one of:
783764
///
784-
/// ```
785-
/// #[cfg(target_arch = "x86")]
786-
/// use std::arch::x86::*;
787-
/// #[cfg(target_arch = "x86_64")]
788-
/// use std::arch::x86_64::*;
789-
///
790-
/// # fn main() {
791-
/// // round to nearest, and suppress exceptions:
792-
/// # let _x =
793-
/// _MM_FROUND_TO_NEAREST_INT | _MM_FROUND_NO_EXC;
794-
/// // round down, and suppress exceptions:
795-
/// # let _x =
796-
/// _MM_FROUND_TO_NEG_INF | _MM_FROUND_NO_EXC;
797-
/// // round up, and suppress exceptions:
798-
/// # let _x =
799-
/// _MM_FROUND_TO_POS_INF | _MM_FROUND_NO_EXC;
800-
/// // truncate, and suppress exceptions:
801-
/// # let _x =
802-
/// _MM_FROUND_TO_ZERO | _MM_FROUND_NO_EXC;
803-
/// // use MXCSR.RC; see `_MM_SET_ROUNDING_MODE`:
804-
/// # let _x =
805-
/// _MM_FROUND_CUR_DIRECTION;
806-
/// # }
807-
/// ```
765+
/// * [`_MM_FROUND_TO_NEAREST_INT`] | [`_MM_FROUND_NO_EXC`]: round to nearest and suppress exceptions
766+
/// * [`_MM_FROUND_TO_NEG_INF`] | [`_MM_FROUND_NO_EXC`]: round down and suppress exceptions
767+
/// * [`_MM_FROUND_TO_POS_INF`] | [`_MM_FROUND_NO_EXC`]: round up and suppress exceptions
768+
/// * [`_MM_FROUND_TO_ZERO`] | [`_MM_FROUND_NO_EXC`]: truncate and suppress exceptions
769+
/// * [`_MM_FROUND_CUR_DIRECTION`]: use `MXCSR.RC` - see [`_MM_SET_ROUNDING_MODE`]
808770
///
809771
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_round_ps)
810772
#[inline]
@@ -824,30 +786,11 @@ pub unsafe fn _mm_round_ps<const ROUNDING: i32>(a: __m128) -> __m128 {
824786
/// result.
825787
/// Rounding is done according to the rounding parameter, which can be one of:
826788
///
827-
/// ```
828-
/// #[cfg(target_arch = "x86")]
829-
/// use std::arch::x86::*;
830-
/// #[cfg(target_arch = "x86_64")]
831-
/// use std::arch::x86_64::*;
832-
///
833-
/// # fn main() {
834-
/// // round to nearest, and suppress exceptions:
835-
/// # let _x =
836-
/// _MM_FROUND_TO_NEAREST_INT | _MM_FROUND_NO_EXC;
837-
/// // round down, and suppress exceptions:
838-
/// # let _x =
839-
/// _MM_FROUND_TO_NEG_INF | _MM_FROUND_NO_EXC;
840-
/// // round up, and suppress exceptions:
841-
/// # let _x =
842-
/// _MM_FROUND_TO_POS_INF | _MM_FROUND_NO_EXC;
843-
/// // truncate, and suppress exceptions:
844-
/// # let _x =
845-
/// _MM_FROUND_TO_ZERO | _MM_FROUND_NO_EXC;
846-
/// // use MXCSR.RC; see `_MM_SET_ROUNDING_MODE`:
847-
/// # let _x =
848-
/// _MM_FROUND_CUR_DIRECTION;
849-
/// # }
850-
/// ```
789+
/// * [`_MM_FROUND_TO_NEAREST_INT`] | [`_MM_FROUND_NO_EXC`]: round to nearest and suppress exceptions
790+
/// * [`_MM_FROUND_TO_NEG_INF`] | [`_MM_FROUND_NO_EXC`]: round down and suppress exceptions
791+
/// * [`_MM_FROUND_TO_POS_INF`] | [`_MM_FROUND_NO_EXC`]: round up and suppress exceptions
792+
/// * [`_MM_FROUND_TO_ZERO`] | [`_MM_FROUND_NO_EXC`]: truncate and suppress exceptions
793+
/// * [`_MM_FROUND_CUR_DIRECTION`]: use `MXCSR.RC` - see [`_MM_SET_ROUNDING_MODE`]
851794
///
852795
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_round_sd)
853796
#[inline]
@@ -867,30 +810,11 @@ pub unsafe fn _mm_round_sd<const ROUNDING: i32>(a: __m128d, b: __m128d) -> __m12
867810
/// of the intrinsic result.
868811
/// Rounding is done according to the rounding parameter, which can be one of:
869812
///
870-
/// ```
871-
/// #[cfg(target_arch = "x86")]
872-
/// use std::arch::x86::*;
873-
/// #[cfg(target_arch = "x86_64")]
874-
/// use std::arch::x86_64::*;
875-
///
876-
/// # fn main() {
877-
/// // round to nearest, and suppress exceptions:
878-
/// # let _x =
879-
/// _MM_FROUND_TO_NEAREST_INT | _MM_FROUND_NO_EXC;
880-
/// // round down, and suppress exceptions:
881-
/// # let _x =
882-
/// _MM_FROUND_TO_NEG_INF | _MM_FROUND_NO_EXC;
883-
/// // round up, and suppress exceptions:
884-
/// # let _x =
885-
/// _MM_FROUND_TO_POS_INF | _MM_FROUND_NO_EXC;
886-
/// // truncate, and suppress exceptions:
887-
/// # let _x =
888-
/// _MM_FROUND_TO_ZERO | _MM_FROUND_NO_EXC;
889-
/// // use MXCSR.RC; see `_MM_SET_ROUNDING_MODE`:
890-
/// # let _x =
891-
/// _MM_FROUND_CUR_DIRECTION;
892-
/// # }
893-
/// ```
813+
/// * [`_MM_FROUND_TO_NEAREST_INT`] | [`_MM_FROUND_NO_EXC`]: round to nearest and suppress exceptions
814+
/// * [`_MM_FROUND_TO_NEG_INF`] | [`_MM_FROUND_NO_EXC`]: round down and suppress exceptions
815+
/// * [`_MM_FROUND_TO_POS_INF`] | [`_MM_FROUND_NO_EXC`]: round up and suppress exceptions
816+
/// * [`_MM_FROUND_TO_ZERO`] | [`_MM_FROUND_NO_EXC`]: truncate and suppress exceptions
817+
/// * [`_MM_FROUND_CUR_DIRECTION`]: use `MXCSR.RC` - see [`_MM_SET_ROUNDING_MODE`]
894818
///
895819
/// [Intel's documentation](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=_mm_round_ss)
896820
#[inline]

0 commit comments

Comments
 (0)