alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2024-12-24 00:31:34 +11:00
Code Issues Packages Projects Releases Wiki Activity

fix some of the doc comments

Browse source
This commit is contained in:
Corwin 2022-08-02 18:56:46 +01:00
parent e675fc5c3e
commit e97b67516f
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
agb-fixnum/src/lib.rs
View file

@ -12,6 +12,7 @@ use core::{
}; };
#[doc(hidden)] #[doc(hidden)]
/// Used internally by the [num!] macro which should be used instead.
pub use agb_macros::num as num_inner; pub use agb_macros::num as num_inner;
/// Can be thought of having the signature `num!(float) -> Num<I, N>`. /// Can be thought of having the signature `num!(float) -> Num<I, N>`.
@ -432,7 +433,7 @@ impl<I: FixedWidthSignedInteger, const N: usize> Num<I, N> {
} }
/// Calculates the cosine of a fixed point number with the domain of [0, 1]. /// Calculates the cosine of a fixed point number with the domain of [0, 1].
/// see <https://github.com/tarcieri/micromath/blob/24584465b48ff4e87cffb709c7848664db896b4f/src/float/cos.rs#L226> /// Uses a [fifth order polynomial](https://github.com/tarcieri/micromath/blob/24584465b48ff4e87cffb709c7848664db896b4f/src/float/cos.rs#L226).
/// ``` /// ```
/// # use agb_fixnum::*; /// # use agb_fixnum::*;
/// let n: Num<i32, 8> = num!(0.); // 0 radians /// let n: Num<i32, 8> = num!(0.); // 0 radians
@ -680,8 +681,8 @@ impl<const N: usize> Vector2D<Num<i32, N>> {
self.magnitude_squared().sqrt() self.magnitude_squared().sqrt()
} }
/// Calculates the magnitude of a vector using the alpha max plus beta min /// Calculates the magnitude of a vector using the [alpha max plus beta min
/// algorithm <https://en.wikipedia.org/wiki/Alpha_max_plus_beta_min_algorithm> /// algorithm](https://en.wikipedia.org/wiki/Alpha_max_plus_beta_min_algorithm)
/// this has a maximum error of less than 4% of the true magnitude, probably /// this has a maximum error of less than 4% of the true magnitude, probably
/// depending on the size of your fixed point approximation /// depending on the size of your fixed point approximation
/// ``` /// ```