Wpm

Struct Wpm 

Source
pub struct Wpm {
    pub raw: f64,
    pub corrected: f64,
    pub actual: f64,
}
Expand description

§Words Per Minute (WPM)

Measures typing speed by calculating how many words (assuming 5 characters per word) are typed per minute. This is the most common metric for typing speed assessment.

§Mathematical Formulas

§Raw WPM

$$WPM_{raw} = \frac{C}{L \cdot T}$$

Where:

§Corrected WPM

$$WPM_{corrected} = WPM_{raw} - \frac{E}{T}$$

Where:

  • $E$ = total errors made

§Actual WPM

$$WPM_{actual} = WPM_{raw} - \frac{E + R}{T}$$

Where:

  • $R$ = total corrections made

§Usage Notes

  • Raw WPM shows pure typing speed without quality consideration
  • Corrected WPM penalizes errors but rewards fixing them
  • Actual WPM penalizes both errors and the time spent correcting them
  • Negative values are possible if error rates are extremely high

Fields§

§raw: f64

Raw WPM: Pure typing speed without error consideration

Formula: (characters / 5) / minutes

§corrected: f64

Corrected WPM: Raw WPM minus errors per minute

Formula: raw_wpm - (errors / minutes)

§actual: f64

Actual WPM: Raw WPM minus both errors and corrections per minute

Formula: raw_wpm - ((errors + corrections) / minutes)

Implementations§

Source§

impl Wpm

Source

pub fn calculate( characters: usize, errors: usize, corrections: usize, minutes: f64, ) -> Self

Calculate Words Per Minute using the formulas described above

§Parameters
  • characters - Total number of characters typed during the session
  • errors - Total number of errors made during the session
  • corrections - Total number of corrections made during the session
  • minutes - Duration of the typing session in minutes
§Returns

A Wpm struct containing raw, corrected, and actual WPM calculations. Wpm calculations are clamped to always be >= 0.0

§Example
use gladius::math::Wpm;

let wpm = Wpm::calculate(250, 5, 2, 5.0);
println!("Raw WPM: {}", wpm.raw);     // 10.0 WPM
println!("Corrected: {}", wpm.corrected); // 9.0 WPM  
println!("Actual: {}", wpm.actual);   // 8.6 WPM

Trait Implementations§

Source§

impl Clone for Wpm

Source§

fn clone(&self) -> Wpm

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Wpm

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Wpm

Source§

fn eq(&self, other: &Wpm) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Wpm

Source§

fn partial_cmp(&self, other: &Wpm) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for Wpm

Source§

impl StructuralPartialEq for Wpm

Auto Trait Implementations§

§

impl Freeze for Wpm

§

impl RefUnwindSafe for Wpm

§

impl Send for Wpm

§

impl Sync for Wpm

§

impl Unpin for Wpm

§

impl UnwindSafe for Wpm

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.