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

fix doc links

This commit is contained in:
Trevor Spiteri 2020-09-17 19:13:52 +02:00
parent c1119a0d12
commit c7c57b09f0
5 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/macros_frac.rs
View File

@ -999,7 +999,7 @@ type OneIntBit = ", $s_fixed, "<U", $s_nbits_m1, ">;
let _overflow = OneIntBit::from_num(0.5).unwrapped_signum();
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_signum(self) -> $Fixed<Frac> {
@ -1035,7 +1035,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MAX.unwrapped_mul(Fix::from_num(4));
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_mul(self, rhs: $Fixed<Frac>) -> $Fixed<Frac> {
@ -1072,7 +1072,7 @@ let quarter = Fix::from_num(1) / 4;
let _overflow = Fix::MAX.unwrapped_div(quarter);
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_div(self, rhs: $Fixed<Frac>) -> $Fixed<Frac> {
@ -1110,7 +1110,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MAX.unwrapped_div_euclid(Fix::from_num(0.25));
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_div_euclid(self, rhs: $Fixed<Frac>) -> $Fixed<Frac> {
@ -1169,7 +1169,7 @@ let _overflow = Fix::MIN.unwrapped_div_euclid_int(-1);
},
"```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_div_euclid_int(self, rhs: $Inner) -> $Fixed<Frac> {
@ -1227,7 +1227,7 @@ let _overflow = Fix::from_num(-7.5).unwrapped_rem_euclid_int(20);
},
"```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_rem_euclid_int(self, rhs: $Inner) -> $Fixed<Frac> {

4
src/macros_from_to.rs
View File

@ -771,7 +771,7 @@ let _overflow = Fix::unwrapped_from_num(too_large);
[`u64`]: https://doc.rust-lang.org/nightly/std/primitive.u64.html
[`u8`]: https://doc.rust-lang.org/nightly/std/primitive.u8.html
[`usize`]: https://doc.rust-lang.org/nightly/std/primitive.usize.html
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
[finite]: https://doc.rust-lang.org/nightly/std/primitive.f64.html#method.is_finite
";
#[inline]
@ -854,7 +854,7 @@ let _overflow = Fix::MAX.unwrapped_to_num::<TooFewIntBits>();
[`u64`]: https://doc.rust-lang.org/nightly/std/primitive.u64.html
[`u8`]: https://doc.rust-lang.org/nightly/std/primitive.u8.html
[`usize`]: https://doc.rust-lang.org/nightly/std/primitive.usize.html
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_to_num<Dst: FromFixed>(self) -> Dst {

18
src/macros_no_frac.rs
View File

@ -1281,7 +1281,7 @@ let _overflow = Fix::from_num(5).unwrapped_neg();",
"
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_neg(self) -> $Fixed<Frac> {
@ -1316,7 +1316,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MAX.unwrapped_add(Fix::from_bits(1));
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_add(self, rhs: $Fixed<Frac>) -> $Fixed<Frac> {
@ -1358,7 +1358,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MIN.unwrapped_sub(Fix::from_bits(1));
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_sub(self, rhs: $Fixed<Frac>) -> $Fixed<Frac> {
@ -1393,7 +1393,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MAX.unwrapped_mul_int(4);
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_mul_int(self, rhs: $Inner) -> $Fixed<Frac> {
@ -1450,7 +1450,7 @@ let _overflow = Fix::MIN.unwrapped_div_int(-1);
},
"```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_div_int(self, rhs: $Inner) -> $Fixed<Frac> {
@ -1488,7 +1488,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::from_num(1).unwrapped_shl(", $s_nbits, ");
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_shl(self, rhs: u32) -> $Fixed<Frac> {
@ -1523,7 +1523,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::from_num(1).unwrapped_shr(", $s_nbits, ");
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_shr(self, rhs: u32) -> $Fixed<Frac> {
@ -1562,7 +1562,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MIN.unwrapped_abs();
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_abs(self) -> $Fixed<Frac> {
@ -1604,7 +1604,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MAX.unwrapped_next_power_of_two();
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_next_power_of_two(self) -> $Fixed<Frac> {

8
src/macros_round.rs
View File

@ -713,7 +713,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MAX.unwrapped_ceil();
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_ceil(self) -> $Fixed<Frac> {
@ -762,7 +762,7 @@ let _overflow = AllFrac::MIN.unwrapped_floor();
},
"```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_floor(self) -> $Fixed<Frac> {
@ -804,7 +804,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MAX.unwrapped_round();
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_round(self) -> $Fixed<Frac> {
@ -841,7 +841,7 @@ type Fix = ", $s_fixed, "<U4>;
let _overflow = Fix::MAX.unwrapped_round_ties_to_even();
```
[exp]: ../index.html#experimental-optional-features
[exp]: index.html#experimental-optional-features
";
#[inline]
pub fn unwrapped_round_ties_to_even(self) -> $Fixed<Frac> {

3
src/traits.rs
View File

@ -688,7 +688,6 @@ where
/// with ties rounded to even, and wrapping on overflow.
fn wrapping_round_ties_to_even(self) -> Self;
#[cfg(feature = "unwrapped")]
/// Unwrapped ceil. Rounds to the next integer towards +∞,
/// panicking on overflow.
@ -1210,7 +1209,7 @@ where
///
/// [exp]: ../index.html#experimental-optional-features
fn unwrapped_shr(self, rhs: u32) -> Self;
/// Overflowing negation.
///
/// Returns a [tuple] of the negated value and a [`bool`],