blockworks-foundation
/
fixed
mirror of https://github.com/blockworks-foundation/fixed.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: use more suitable see-also links for {Wrapping,Unwrapped}

This commit is contained in:
Trevor Spiteri 2021-05-04 23:53:19 +02:00
parent 3375450767
commit 01c38307cb
2 changed files with 108 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
src/unwrapped.rs
View File

@ -437,8 +437,10 @@ impl<F: Fixed> Unwrapped<F> {
/// implemented, in which case this method returns
/// <code>[Unwrapped]\(src.[unwrapped\_to\_fixed][ToFixed::unwrapped_to_fixed]\())</code>.
///
/// See also <code>FixedI32::[from\_num][FixedI32::from_num]</code> and
/// <code>FixedU32::[from\_num][FixedU32::from_num]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_from\_num][FixedI32::unwrapped_from_num]</code>
/// and
/// <code>FixedU32::[unwrapped\_from\_num][FixedU32::unwrapped_from_num]</code>.
///
/// # Panics
///
@ -497,8 +499,10 @@ impl<F: Fixed> Unwrapped<F> {
/// implemented, in which case this method returns
/// <code>Dst::[unwrapped\_from\_fixed][FromFixed::unwrapped_from_fixed]\(self.0)</code>.
///
/// See also <code>FixedI32::[to\_num][FixedI32::to_num]</code> and
/// <code>FixedU32::[to\_num][FixedU32::to_num]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_to\_num][FixedI32::unwrapped_to_num]</code>
/// and
/// <code>FixedU32::[unwrapped\_to\_num][FixedU32::unwrapped_to_num]</code>.
///
/// # Examples
///
@ -665,8 +669,9 @@ impl<F: Fixed> Unwrapped<F> {
/// Unwrapped ceil. Rounds to the next integer towards +∞, panicking
/// on overflow.
///
/// See also <code>FixedI32::[ceil][FixedI32::ceil]</code> and
/// <code>FixedU32::[ceil][FixedU32::ceil]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_ceil][FixedI32::unwrapped_ceil]</code> and
/// <code>FixedU32::[unwrapped\_ceil][FixedU32::unwrapped_ceil]</code>.
///
/// # Panics
///
@ -698,8 +703,9 @@ impl<F: Fixed> Unwrapped<F> {
/// Overflow can only occur for signed numbers with zero integer
/// bits.
///
/// See also <code>FixedI32::[floor][FixedI32::floor]</code> and
/// <code>FixedU32::[floor][FixedU32::floor]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_floor][FixedI32::unwrapped_floor]</code> and
/// <code>FixedU32::[unwrapped\_floor][FixedU32::unwrapped_floor]</code>.
///
/// # Panics
///
@ -728,8 +734,9 @@ impl<F: Fixed> Unwrapped<F> {
/// Unwrapped round. Rounds to the next integer to the nearest,
/// with ties rounded away from zero, and panics on overflow.
///
/// See also <code>FixedI32::[round][FixedI32::round]</code> and
/// <code>FixedU32::[round][FixedU32::round]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_round][FixedI32::unwrapped_round]</code> and
/// <code>FixedU32::[unwrapped\_round][FixedU32::unwrapped_round]</code>.
///
/// # Panics
///
@ -760,9 +767,9 @@ impl<F: Fixed> Unwrapped<F> {
/// with ties rounded to even, and panics on overflow.
///
/// See also
/// <code>FixedI32::[round\_ties\_to\_even][FixedI32::round_ties_to_even]</code>
/// <code>FixedI32::[unwrapped\_round\_ties\_to\_even][FixedI32::unwrapped_round_ties_to_even]</code>
/// and
/// <code>FixedU32::[round\_ties\_to\_even][FixedU32::round_ties_to_even]</code>.
/// <code>FixedU32::[unwrapped\_round\_ties\_to\_even][FixedU32::unwrapped_round_ties_to_even]</code>.
///
/// # Panics
///
@ -997,8 +1004,10 @@ impl<F: Fixed> Unwrapped<F> {
/// Returns the distance from `self` to `other`.
///
/// See also <code>FixedI32::[distance][FixedI32::distance]</code> and
/// <code>FixedU32::[distance][FixedU32::distance]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_distance][FixedI32::unwrapped_distance]</code>
/// and
/// <code>FixedU32::[unwrapped\_distance][FixedU32::unwrapped_distance]</code>.
///
/// # Panics
///
@ -1047,8 +1056,9 @@ impl<F: Fixed> Unwrapped<F> {
/// Returns the reciprocal (inverse), 1/`self`.
///
/// See also <code>FixedI32::[recip][FixedI32::recip]</code> and
/// <code>FixedU32::[recip][FixedU32::recip]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_recip][FixedI32::unwrapped_recip]</code> and
/// <code>FixedU32::[unwrapped\_recip][FixedU32::unwrapped_recip]</code>.
///
/// # Panics
///
@ -1077,8 +1087,10 @@ impl<F: Fixed> Unwrapped<F> {
/// Multiply and add. Returns `self` × `mul` + `add`.
///
/// See also <code>FixedI32::[mul\_add][FixedI32::mul_add]</code> and
/// <code>FixedU32::[mul\_add][FixedU32::mul_add]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_mul\_add][FixedI32::unwrapped_mul_add]</code>
/// and
/// <code>FixedU32::[unwrapped\_mul\_add][FixedU32::unwrapped_mul_add]</code>.
///
/// # Panics
///
@ -1114,8 +1126,10 @@ impl<F: Fixed> Unwrapped<F> {
/// Multiply and accumulate. Adds (`a` × `b`) to `self`.
///
/// See also <code>FixedI32::[mul\_acc][FixedI32::mul_acc]</code> and
/// <code>FixedU32::[mul\_acc][FixedU32::mul_acc]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_mul\_acc][FixedI32::unwrapped_mul_acc]</code>
/// and
/// <code>FixedU32::[unwrapped\_mul\_acc][FixedU32::unwrapped_mul_acc]</code>.
///
/// # Panics
///
@ -1144,8 +1158,10 @@ impl<F: Fixed> Unwrapped<F> {
/// Euclidean division.
///
/// See also <code>FixedI32::[div\_euclid][FixedI32::div_euclid]</code> and
/// <code>FixedU32::[div\_euclid][FixedU32::div_euclid]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_div\_euclid][FixedI32::unwrapped_div_euclid]</code>
/// and
/// <code>FixedU32::[unwrapped\_div\_euclid][FixedU32::unwrapped_div_euclid]</code>.
///
/// # Panics
///
@ -1176,8 +1192,10 @@ impl<F: Fixed> Unwrapped<F> {
/// Remainder for Euclidean division.
///
/// See also <code>FixedI32::[rem\_euclid][FixedI32::rem_euclid]</code> and
/// <code>FixedU32::[rem\_euclid][FixedU32::rem_euclid]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_rem\_euclid][FixedI32::unwrapped_rem_euclid]</code>
/// and
/// <code>FixedU32::[unwrapped\_rem\_euclid][FixedU32::unwrapped_rem_euclid]</code>.
///
/// # Panics
///
@ -1202,8 +1220,9 @@ impl<F: Fixed> Unwrapped<F> {
/// Euclidean division by an integer.
///
/// See also
/// <code>FixedI32::[div\_euclid\_int][FixedI32::div_euclid_int]</code> and
/// <code>FixedU32::[div\_euclid\_int][FixedU32::div_euclid_int]</code>.
/// <code>FixedI32::[unwrapped\_div\_euclid\_int][FixedI32::unwrapped_div_euclid_int]</code>
/// and
/// <code>FixedU32::[unwrapped\_div\_euclid\_int][FixedU32::unwrapped_div_euclid_int]</code>.
///
/// # Panics
///
@ -1234,8 +1253,9 @@ impl<F: Fixed> Unwrapped<F> {
/// Remainder for Euclidean division.
///
/// See also
/// <code>FixedI32::[rem\_euclid\_int][FixedI32::rem_euclid_int]</code> and
/// <code>FixedU32::[rem\_euclid\_int][FixedU32::rem_euclid_int]</code>.
/// <code>FixedI32::[unwrapped\_rem\_euclid\_int][FixedI32::unwrapped_rem_euclid_int]</code>
/// and
/// <code>FixedU32::[unwrapped\_rem\_euclid\_int][FixedU32::unwrapped_rem_euclid_int]</code>.
///
/// # Panics
///
@ -1332,7 +1352,8 @@ impl<F: FixedSigned> Unwrapped<F> {
/// Overflow can only occur when trying to find the absolute value
/// of the minimum value.
///
/// See also <code>FixedI32::[abs][FixedI32::abs]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_abs][FixedI32::unwrapped_abs]</code>.
///
/// # Panics
///
@ -1359,7 +1380,8 @@ impl<F: FixedSigned> Unwrapped<F> {
/// Returns a number representing the sign of `self`.
///
/// See also <code>FixedI32::[signum][FixedI32::signum]</code>.
/// See also
/// <code>FixedI32::[unwrapped\_signum][FixedI32::unwrapped_signum]</code>.
///
/// # Panics
///
@ -1457,7 +1479,7 @@ impl<F: FixedUnsigned> Unwrapped<F> {
/// Returns the smallest power of two that is ≥ `self`.
///
/// See also
/// <code>FixedU32::[next\_power\_of\_two][FixedU32::next_power_of_two]</code>.
/// <code>FixedU32::[unwrapped\_next\_power\_of\_two][FixedU32::unwrapped_next_power_of_two]</code>.
///
/// # Panics
///

90
src/wrapping.rs
View File

@ -434,8 +434,10 @@ impl<F: Fixed> Wrapping<F> {
/// implemented, in which case this method returns
/// <code>[Wrapping]\(src.[wrapping\_to\_fixed][ToFixed::wrapping_to_fixed]\())</code>.
///
/// See also <code>FixedI32::[from\_num][FixedI32::from_num]</code> and
/// <code>FixedU32::[from\_num][FixedU32::from_num]</code>.
/// See also
/// <code>FixedI32::[wrapping\_from\_num][FixedI32::wrapping_from_num]</code>
/// and
/// <code>FixedU32::[wrapping\_from\_num][FixedU32::wrapping_from_num]</code>.
///
/// # Panics
///
@ -492,8 +494,8 @@ impl<F: Fixed> Wrapping<F> {
/// implemented, in which case this method returns
/// <code>Dst::[wrapping\_from\_fixed][FromFixed::wrapping_from_fixed]\(self.0)</code>.
///
/// See also <code>FixedI32::[to\_num][FixedI32::to_num]</code> and
/// <code>FixedU32::[to\_num][FixedU32::to_num]</code>.
/// See also <code>FixedI32::[wrapping\_to\_num][FixedI32::wrapping_to_num]</code> and
/// <code>FixedU32::[wrapping\_to\_num][FixedU32::wrapping_to_num]</code>.
///
/// # Examples
///
@ -527,9 +529,9 @@ impl<F: Fixed> Wrapping<F> {
/// Rounding is to the nearest, with ties rounded to even.
///
/// See also
/// <code>FixedI32::[from\_str\_binary][FixedI32::from_str_binary]</code>
/// <code>FixedI32::[wrapping\_from\_str\_binary][FixedI32::wrapping_from_str_binary]</code>
/// and
/// <code>FixedU32::[from\_str\_binary][FixedU32::from_str_binary]</code>.
/// <code>FixedU32::[wrapping\_from\_str\_binary][FixedU32::wrapping_from_str_binary]</code>.
///
/// # Examples
///
@ -548,8 +550,9 @@ impl<F: Fixed> Wrapping<F> {
/// Rounding is to the nearest, with ties rounded to even.
///
/// See also
/// <code>FixedI32::[from\_str\_octal][FixedI32::from_str_octal]</code> and
/// <code>FixedU32::[from\_str\_octal][FixedU32::from_str_octal]</code>.
/// <code>FixedI32::[wrapping\_from\_str\_octal][FixedI32::wrapping_from_str_octal]</code>
/// and
/// <code>FixedU32::[wrapping\_from\_str\_octal][FixedU32::wrapping_from_str_octal]</code>.
///
/// # Examples
///
@ -567,8 +570,10 @@ impl<F: Fixed> Wrapping<F> {
///
/// Rounding is to the nearest, with ties rounded to even.
///
/// See also <code>FixedI32::[from\_str\_hex][FixedI32::from_str_hex]</code>
/// and <code>FixedU32::[from\_str\_hex][FixedU32::from_str_hex]</code>.
/// See also
/// <code>FixedI32::[wrapping\_from\_str\_hex][FixedI32::wrapping_from_str_hex]</code>
/// and
/// <code>FixedU32::[wrapping\_from\_str\_hex][FixedU32::wrapping_from_str_hex]</code>.
///
/// # Examples
///
@ -656,8 +661,9 @@ impl<F: Fixed> Wrapping<F> {
/// Wrapping ceil. Rounds to the next integer towards +∞, wrapping
/// on overflow.
///
/// See also <code>FixedI32::[ceil][FixedI32::ceil]</code> and
/// <code>FixedU32::[ceil][FixedU32::ceil]</code>.
/// See also
/// <code>FixedI32::[wrapping\_ceil][FixedI32::wrapping_ceil]</code> and
/// <code>FixedU32::[wrapping\_ceil][FixedU32::wrapping_ceil]</code>.
///
/// # Examples
///
@ -678,8 +684,9 @@ impl<F: Fixed> Wrapping<F> {
/// Overflow can only occur for signed numbers with zero integer
/// bits.
///
/// See also <code>FixedI32::[floor][FixedI32::floor]</code> and
/// <code>FixedU32::[floor][FixedU32::floor]</code>.
/// See also
/// <code>FixedI32::[wrapping\_floor][FixedI32::wrapping_floor]</code> and
/// <code>FixedU32::[wrapping\_floor][FixedU32::wrapping_floor]</code>.
///
/// # Examples
///
@ -700,8 +707,9 @@ impl<F: Fixed> Wrapping<F> {
/// Wrapping round. Rounds to the next integer to the nearest,
/// with ties rounded away from zero, and wrapping on overflow.
///
/// See also <code>FixedI32::[round][FixedI32::round]</code> and
/// <code>FixedU32::[round][FixedU32::round]</code>.
/// See also
/// <code>FixedI32::[wrapping\_round][FixedI32::wrapping_round]</code> and
/// <code>FixedU32::[wrapping\_round][FixedU32::wrapping_round]</code>.
///
/// # Examples
///
@ -721,9 +729,9 @@ impl<F: Fixed> Wrapping<F> {
/// with ties rounded to even, and wrapping on overflow.
///
/// See also
/// <code>FixedI32::[round\_ties\_to\_even][FixedI32::round_ties_to_even]</code>
/// <code>FixedI32::[wrapping\_round\_ties\_to\_even][FixedI32::wrapping_round_ties_to_even]</code>
/// and
/// <code>FixedU32::[round\_ties\_to\_even][FixedU32::round_ties_to_even]</code>.
/// <code>FixedU32::[wrapping\_round\_ties\_to\_even][FixedU32::wrapping_round_ties_to_even]</code>.
///
/// # Examples
///
@ -945,8 +953,10 @@ impl<F: Fixed> Wrapping<F> {
/// Returns the distance from `self` to `other`.
///
/// See also <code>FixedI32::[distance][FixedI32::distance]</code> and
/// <code>FixedU32::[distance][FixedU32::distance]</code>.
/// See also
/// <code>FixedI32::[wrapping\_distance][FixedI32::wrapping_distance]</code>
/// and
/// <code>FixedU32::[wrapping\_distance][FixedU32::wrapping_distance]</code>.
///
/// # Examples
///
@ -984,8 +994,9 @@ impl<F: Fixed> Wrapping<F> {
/// Returns the reciprocal (inverse), 1/`self`.
///
/// See also <code>FixedI32::[recip][FixedI32::recip]</code> and
/// <code>FixedU32::[recip][FixedU32::recip]</code>.
/// See also
/// <code>FixedI32::[wrapping\_recip][FixedI32::wrapping_recip]</code> and
/// <code>FixedU32::[wrapping\_recip][FixedU32::wrapping_recip]</code>.
///
/// # Panics
///
@ -1007,8 +1018,10 @@ impl<F: Fixed> Wrapping<F> {
/// Multiply and add. Returns `self` × `mul` + `add`.
///
/// See also <code>FixedI32::[mul\_add][FixedI32::mul_add]</code> and
/// <code>FixedU32::[mul\_add][FixedU32::mul_add]</code>.
/// See also
/// <code>FixedI32::[wrapping\_mul\_add][FixedI32::wrapping_mul_add]</code>
/// and
/// <code>FixedU32::[wrapping\_mul\_add][FixedU32::wrapping_mul_add]</code>.
///
/// # Examples
///
@ -1029,8 +1042,10 @@ impl<F: Fixed> Wrapping<F> {
/// Multiply and accumulate. Adds (`a` × `b`) to `self`.
///
/// See also <code>FixedI32::[mul\_acc][FixedI32::mul_acc]</code> and
/// <code>FixedU32::[mul\_acc][FixedU32::mul_acc]</code>.
/// See also
/// <code>FixedI32::[wrapping\_mul\_acc][FixedI32::wrapping_mul_acc]</code>
/// and
/// <code>FixedU32::[wrapping\_mul\_acc][FixedU32::wrapping_mul_acc]</code>.
///
/// # Examples
///
@ -1051,8 +1066,10 @@ impl<F: Fixed> Wrapping<F> {
/// Euclidean division.
///
/// See also <code>FixedI32::[div\_euclid][FixedI32::div_euclid]</code> and
/// <code>FixedU32::[div\_euclid][FixedU32::div_euclid]</code>.
/// See also
/// <code>FixedI32::[wrapping\_div\_euclid][FixedI32::wrapping_div_euclid]</code>
/// and
/// <code>FixedU32::[wrapping\_div\_euclid][FixedU32::wrapping_div_euclid]</code>.
///
/// # Panics
///
@ -1102,8 +1119,9 @@ impl<F: Fixed> Wrapping<F> {
/// Euclidean division by an integer.
///
/// See also
/// <code>FixedI32::[div\_euclid\_int][FixedI32::div_euclid_int]</code> and
/// <code>FixedU32::[div\_euclid\_int][FixedU32::div_euclid_int]</code>.
/// <code>FixedI32::[wrapping\_div\_euclid\_int][FixedI32::wrapping_div_euclid_int]</code>
/// and
/// <code>FixedU32::[wrapping\_div\_euclid\_int][FixedU32::wrapping_div_euclid_int]</code>.
///
/// # Panics
///
@ -1127,8 +1145,9 @@ impl<F: Fixed> Wrapping<F> {
/// Remainder for Euclidean division.
///
/// See also
/// <code>FixedI32::[rem\_euclid\_int][FixedI32::rem_euclid_int]</code> and
/// <code>FixedU32::[rem\_euclid\_int][FixedU32::rem_euclid_int]</code>.
/// <code>FixedI32::[wrapping\_rem\_euclid\_int][FixedI32::wrapping_rem_euclid_int]</code>
/// and
/// <code>FixedU32::[wrapping\_rem\_euclid\_int][FixedU32::wrapping_rem_euclid_int]</code>.
///
/// # Panics
///
@ -1215,7 +1234,7 @@ impl<F: FixedSigned> Wrapping<F> {
/// Overflow can only occur when trying to find the absolute value
/// of the minimum value.
///
/// See also <code>FixedI32::[abs][FixedI32::abs]</code>.
/// See also <code>FixedI32::[wrapping\_abs][FixedI32::wrapping_abs]</code>.
///
/// # Examples
///
@ -1246,7 +1265,8 @@ impl<F: FixedSigned> Wrapping<F> {
/// that for a positive number, −1 is returned, because +1
/// does not fit and is wrapped to −1.
///
/// See also <code>FixedI32::[signum][FixedI32::signum]</code>.
/// See also
/// <code>FixedI32::[wrapping\_signum][FixedI32::wrapping_signum]</code>.
///
/// # Examples
///
@ -1340,7 +1360,7 @@ impl<F: FixedUnsigned> Wrapping<F> {
/// If the next power of two is too large to fit, it is wrapped to zero.
///
/// See also
/// <code>FixedU32::[next\_power\_of\_two][FixedU32::next_power_of_two]</code>.
/// <code>FixedU32::[wrapping\_next\_power\_of\_two][FixedU32::wrapping_next_power_of_two]</code>.
///
/// # Examples
///