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

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

use crate::space::Xyz;

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

impl TristimulusResponse {
  /// Creates a new tristimulus response from X, Y, Z values.
  pub const fn new(x: f64, y: f64, z: f64) -> Self {
    Self([x, y, z])
  }

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

  /// Returns the X component.
  pub fn x(&self) -> f64 {
    self.0[0]
  }

  /// Returns the Y component.
  pub fn y(&self) -> f64 {
    self.0[1]
  }

  /// Returns the Z component.
  pub fn z(&self) -> f64 {
    self.0[2]
  }
}

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

impl<T> From<T> for TristimulusResponse
where
  T: Into<Xyz>,
{
  fn from(xyz: T) -> Self {
    let xyz = xyz.into();
    Self::new(xyz.x(), xyz.y(), xyz.z())
  }
}

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

  mod display {
    use pretty_assertions::assert_eq;

    use super::*;

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

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

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

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

  mod from_xyz {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_converts_from_xyz() {
      let xyz = Xyz::new(0.5, 0.6, 0.7);
      let response = TristimulusResponse::from(xyz);

      assert_eq!(response.x(), 0.5);
      assert_eq!(response.y(), 0.6);
      assert_eq!(response.z(), 0.7);
    }

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

      assert_eq!(response.x(), 0.1);
      assert_eq!(response.y(), 0.2);
      assert_eq!(response.z(), 0.3);
    }
  }
}