eazing 0.0.1

The blazingly fast and mathematically optimized `easing functions` kit.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use crate::easing::Curve;

/// The [`InSmoother`] Curve.
///
/// #### examples.
///
/// ```
/// use eazing::Curve;
/// use eazing::interpolation::polynomial::smootherstep::InSmoother;
///
/// let p = InSmoother.y(1.0);
/// ```
#[derive(Debug)]
pub struct InSmoother;

impl Curve for InSmoother {
  #[inline]
  fn y(&self, _p: f32) -> f32 {
    unimplemented!()
  }
}

#[test]
fn test_in_smoother() {
  let p = InSmoother.y(0.8);

  assert_eq!(p, 0.90450853);
}

/// The [`OutSmoother`] Curve.
///
/// #### examples.
///
/// ```
/// use eazing::Curve;
/// use eazing::interpolation::polynomial::smootherstep::OutSmoother;
///
/// let p = OutSmoother.y(1.0);
/// ```
#[derive(Debug)]
pub struct OutSmoother;

impl Curve for OutSmoother {
  #[inline]
  fn y(&self, _p: f32) -> f32 {
    unimplemented!()
  }
}

#[test]
fn test_out_smoother() {
  let p = OutSmoother.y(0.8);

  assert_eq!(p, 0.90450853);
}

/// The Non-linear Interpolation.
///
/// Interpolates smoothly between `min` and `max`. It will accelerated from the
/// start and deccelerated toward the end with a cubic easing.
///
/// #### params.
///
/// |      |                            |
/// |:-----|:---------------------------|
/// | `p`  | The progress.              |
/// | `x0` | The `min` start value.     |
/// | `x1` | The `max` end value.       |
///
/// #### returns.
///
/// `f32` — The interpolated result between the two float values.
///
/// #### examples.
///
/// ```
/// use eazing::interpolation::polynomial::smootherstep::smootherstep;
///
/// let p = smootherstep(0.25, 0.0, 1.0);
///
/// assert_eq!(p, 0.103515625);
/// ```
///
/// #### notes.
///
/// The formula was suggested by Ken Perlin. For more information about the
/// formula go to the [wiki](<https://en.wikipedia.org/wiki/Smoothstep>)
#[inline]
pub fn smootherstep(p: f32, x0: f32, x1: f32) -> f32 {
  let mut p = (p - x0) / (x1 - x0);

  p = p.clamp(0.0, 1.0);
  p * p * p * (p * (6.0 * p - 15.0) + 10.0)
}