Skip to content

Add scaling_factor method to FixedPoint #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PTaylor-us merged 2 commits into from
Sep 12, 2021
Merged

Add scaling_factor method to FixedPoint #113

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23bdb05
Add scaling_factor method to FixedPoint
Sh3Rm4n Aug 20, 2021
91ce1a9
docs(fixed_point): add short example to new `scaling_factor` method
PTaylor-us Sep 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/fixed_point.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,17 @@ pub trait FixedPoint: Sized + Copy {
/// ```
fn integer(&self) -> Self::T;

/// Returns the _scaling factor_ [`Fraction`] part
///
/// ```rust
/// # use embedded_time::{ rate::*};
/// #
/// assert_eq!(Kilohertz(45_u32).scaling_factor(), Fraction::new(1_000, 1));
/// ```
fn scaling_factor(&self) -> Fraction {
Self::SCALING_FACTOR
}

/// Constructs a `FixedPoint` value from _integer_ and _scaling-factor_ ([`Fraction`]) parts
///
/// # Errors
Expand Down