farg 0.4.5

A Rust library for colorimetry, color space conversions, and color manipulation.
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

use std::fmt::{Display, Formatter, Result as FmtResult};

use crate::space::Lms;

/// An LMS cone response at a single wavelength.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ConeResponse([f64; 3]);

impl ConeResponse {
  /// Creates a new cone response from L, M, S values.
  pub const fn new(l: f64, m: f64, s: f64) -> Self {
    Self([l, m, s])
  }

  /// Returns the [L, M, S] components as an array.
  pub fn components(&self) -> [f64; 3] {
    self.0
  }

  /// Returns the L (long) cone response.
  pub fn l(&self) -> f64 {
    self.0[0]
  }

  /// Alias for [`Self::l`].
  pub fn long(&self) -> f64 {
    self.l()
  }

  /// Returns the M (medium) cone response.
  pub fn m(&self) -> f64 {
    self.0[1]
  }

  /// Alias for [`Self::m`].
  pub fn medium(&self) -> f64 {
    self.m()
  }

  /// Returns the S (short) cone response.
  pub fn s(&self) -> f64 {
    self.0[2]
  }

  /// Alias for [`Self::s`].
  pub fn short(&self) -> f64 {
    self.s()
  }
}

impl Display for ConeResponse {
  fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
    write!(
      f,
      "LMS({:.precision$}, {:.precision$}, {:.precision$})",
      self.0[0],
      self.0[1],
      self.0[2],
      precision = f.precision().unwrap_or(4)
    )
  }
}

impl<T> From<T> for ConeResponse
where
  T: Into<Lms>,
{
  fn from(lms: T) -> Self {
    let lms = lms.into();
    Self::new(lms.l(), lms.m(), lms.s())
  }
}

#[cfg(test)]
mod test {
  use super::*;

  mod display {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_formats_with_default_precision() {
      let response = ConeResponse::new(0.12345678, 0.23456789, 0.34567890);

      assert_eq!(format!("{}", response), "LMS(0.1235, 0.2346, 0.3457)");
    }

    #[test]
    fn it_formats_with_custom_precision() {
      let response = ConeResponse::new(0.12345678, 0.23456789, 0.34567890);

      assert_eq!(format!("{:.2}", response), "LMS(0.12, 0.23, 0.35)");
      assert_eq!(format!("{:.6}", response), "LMS(0.123457, 0.234568, 0.345679)");
    }
  }

  mod from_lms {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_converts_from_lms() {
      let lms = Lms::new(0.5, 0.6, 0.7);
      let response = ConeResponse::from(lms);

      assert_eq!(response.l(), 0.5);
      assert_eq!(response.m(), 0.6);
      assert_eq!(response.s(), 0.7);
    }

    #[test]
    fn it_converts_from_array() {
      let response = ConeResponse::from([0.1, 0.2, 0.3]);

      assert_eq!(response.l(), 0.1);
      assert_eq!(response.m(), 0.2);
      assert_eq!(response.s(), 0.3);
    }
  }

  mod long {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_aliases_l() {
      let response = ConeResponse::new(0.5, 0.6, 0.7);

      assert_eq!(response.long(), response.l());
    }
  }

  mod medium {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_aliases_m() {
      let response = ConeResponse::new(0.5, 0.6, 0.7);

      assert_eq!(response.medium(), response.m());
    }
  }

  mod short {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_aliases_s() {
      let response = ConeResponse::new(0.5, 0.6, 0.7);

      assert_eq!(response.short(), response.s());
    }
  }
}