Removed some unnecessary comments and corrected errors in others.

dragonfly-ai · dragonfly-ai · commit bb8881587900 · 2025-08-31T19:58:24.000-06:00
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/cie/Illuminant.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/cie/Illuminant.scala
@@ -20,8 +20,6 @@ import narr.*
 
 import slash.matrix.*
 
-
-
 /**
  * From: https://en.wikipedia.org/wiki/Standard_illuminant
  * "A standard illuminant is a theoretical source of visible light with a spectral power distribution that is published.
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/huesat/HSL.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/huesat/HSL.scala
@@ -41,7 +41,7 @@ trait HSL extends HueSaturation { self: WorkingSpace =>
     }
 
     /**
-     * HSL is the primary case class for representing colors in HSL space.
+     * HSL is the primary type for representing colors in HSL space.
      *
      * @constructor Create a new HSV object from three Double values.  This constructor does not validate input parameters.
      *              For values taken from user input, sensors, or otherwise uncertain sources, consider using the factory method in the Color companion object.
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/huesat/HSV.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/huesat/HSV.scala
@@ -41,7 +41,7 @@ trait HSV extends HueSaturation { self: WorkingSpace =>
     }
 
     /**
-     * HSV is the primary case class for representing colors in HSV space.
+     * HSV is the primary type for representing colors in HSV space.
      *
      * @constructor Create a new HSV object from three Double values.  This constructor does not validate
      *              input parameters.  For values taken from user input, sensors, or otherwise uncertain sources, consider using
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/perceptual/Lab.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/perceptual/Lab.scala
@@ -46,9 +46,6 @@ trait Lab { self: WorkingSpace =>
      */
     def apply(L: Double, a: Double, b: Double): Lab = apply(NArray[Double](a, b, L))
 
-    //    override val rgbGamut:Gamut = Gamut.fromRGB(transform = (v:XYZ) => Vector3(fromXYZ(v).values))
-    //    override def toString:String = s"${illuminant}L*a*b*"
-
     inline def f(t: Double): Double = if (t > ϵ) Math.cbrt(t) else (t * `k/116`) + `16/116`
 
     inline def fInverse(t: Double): Double = if (t > `∛ϵ`) cubeInPlace(t) else (`116/k` * t) - `16/k`
@@ -99,9 +96,6 @@ trait Lab { self: WorkingSpace =>
     override def toString:String = "Lab"
   }
 
-//  case class Lab private(override val values: NArray[Double]) extends PerceptualColorModel[Lab] {
-//    override type VEC = this.type with Lab
-
   type Lab = Lab.Lab
 
   given PerceptualColorModel[Lab] with {
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/perceptual/Luv.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/perceptual/Luv.scala
@@ -103,10 +103,6 @@ trait Luv { self: WorkingSpace =>
       )
     }
 
-//    override val rgbGamut:Gamut = Gamut.fromRGB(transform = (v:XYZ) => Vector3(fromXYZ(v).values))
-
-    //    override def toString:String = s"${illuminant}L*u*v*"
-
     def L(luv: Luv): Double = luv(2)
 
     def u(luv: Luv): Double = luv(0)
@@ -121,14 +117,11 @@ trait Luv { self: WorkingSpace =>
   }
 
   /**
-   * LUV is the base trait for classes that encode colors in the CIE L*u*v* color space.
+   * LUV is the primary type to represent colors from the CIE L*u*v* color space.
    *
    * @see [[https://en.wikipedia.org/wiki/CIELUV]] for more information on CIE L*u*v*.
    */
 
-//  case class Luv private(override val values: NArray[Double]) extends PerceptualColorModel[Luv] {
-//    override type VEC = this.type with Luv
-
   type Luv = Luv.Luv
 
   given PerceptualColorModel[Luv] with {
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/perceptual/XYZ.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/perceptual/XYZ.scala
@@ -82,7 +82,7 @@ trait XYZ { self:WorkingSpace =>
 
   type XYZ = XYZ.XYZ
 
-  given PerceptualColorModel[XYZ] with { //case class XYZ private(override val values: NArray[Double]) extends PerceptualColorModel[XYZ] {
+  given PerceptualColorModel[XYZ] with {
     extension (xyz: XYZ) {
       override inline def copy: XYZ = XYZ.copy(xyz)
 
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/LRGB.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/LRGB.scala
@@ -54,12 +54,6 @@ trait LRGB { self: WorkingSpace =>
      */
     def apply(red: Double, green: Double, blue: Double): LRGB = apply(NArray[Double](red, green, blue))
 
-//    def apply(argb: ARGB32): RGB = apply(`1/255` * argb.red, `1/255` * argb.green, `1/255` * argb.blue)
-//
-//    def apply(rgba: RGBA32): RGB = apply(`1/255` * rgba.red, `1/255` * rgba.green, `1/255` * rgba.blue)
-
-    //override def fromRGB(rgb: RGB): RGB = apply(rgb.red, rgb.green, rgb.blue)
-
     /**
      * Factory method to create a fully Opaque RGB color; one with an alpha value of 1.0.
      * Because this method validates each intensity, it sacrifices performance for safety.
@@ -117,8 +111,6 @@ trait LRGB { self: WorkingSpace =>
     override def toString:String = "LRGB"
   }
 
-//  case class RGB private(override val values: NArray[Double]) extends VectorColorModel[RGB] {
-//    override type VEC = this.type with RGB
   type LRGB = LRGB.LRGB
 
   given VectorColorModel[LRGB] with {
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/RGB.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/RGB.scala
@@ -55,12 +55,6 @@ trait RGB { self: WorkingSpace =>
      */
     def apply(red: Double, green: Double, blue: Double): RGB = apply(NArray[Double](red, green, blue))
 
-//    def apply(argb: ARGB32): RGB = apply(`1/255` * argb.red, `1/255` * argb.green, `1/255` * argb.blue)
-//
-//    def apply(rgba: RGBA32): RGB = apply(`1/255` * rgba.red, `1/255` * rgba.green, `1/255` * rgba.blue)
-
-    //override def fromRGB(rgb: RGB): RGB = apply(rgb.red, rgb.green, rgb.blue)
-
     /**
      * Factory method to create a fully Opaque RGB color; one with an alpha value of 1.0.
      * Because this method validates each intensity, it sacrifices performance for safety.
@@ -116,8 +110,6 @@ trait RGB { self: WorkingSpace =>
     override def toString:String = "RGB"
   }
 
-//  case class RGB private(override val values: NArray[Double]) extends VectorColorModel[RGB] {
-//    override type VEC = this.type with RGB
   type RGB = RGB.RGB
 
   given VectorColorModel[RGB] with {
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/ARGB32.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/ARGB32.scala
@@ -155,14 +155,14 @@ trait ARGB32 extends DiscreteRGB { self: WorkingSpace =>
   type ARGB32 = ARGB32.ARGB32
 
   /**
-   * ARGB is the primary case class for representing colors in ARGB space.
+   * ARGB is the primary type for representing colors in ARGB space.
    *
    * @constructor Create a new ARGB object from an Int.
    * @see [[https://en.wikipedia.org/wiki/RGB_color_space]] for more information on the RGB color space.
    * @param argb a 32 bit integer that represents this color in ARGB space.
    *             The most significant byte encodes the alpha value, the second most significant byte encodes red,
    *             the third most significant byte encodes green, and the least significant byte encodes blue.
-   * @return an instance of the ARGB case class.
+   * @return an instance of the ARGB color model.
    * @example {{{
    * val c = ARGB32(-1)  // returns fully opaque white
    * c.toString()  // returns "ARGB32(255,255,255,255)"
@@ -172,7 +172,6 @@ trait ARGB32 extends DiscreteRGB { self: WorkingSpace =>
   given DiscreteRGB[ARGB32] with {
     extension (argb: ARGB32) {
 
-      ///case class ARGB32(argb: Int) extends DiscreteRGB[ARGB32] {
       /**
        * @return the alpha component of this color in ARGB space.
        */
@@ -197,19 +196,6 @@ trait ARGB32 extends DiscreteRGB { self: WorkingSpace =>
 
       override def similarity(that: ARGB32): Double = ARGB32.similarity(argb, that)
 
-//      /**
-//       * @return the hashcode.  For all color types, the hashcode function returns the same result as argb
-//       */
-//      def hashCode: Int = argb
-
-//      /**
-//       * @return true if these colors are equal in ARGB32 space, false otherwise
-//       */
-//      def equals(obj: Any): Boolean = obj match {
-//        case that: ARGB32 => argb == that
-//        case _ => false
-//      }
-
       /**
        * @return a hexadecimal string representing the rgba integer for this color.
        * @example {{{
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/ARGB64.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/ARGB64.scala
@@ -136,14 +136,14 @@ trait ARGB64 extends DiscreteRGB { self: WorkingSpace =>
   type ARGB64 = ARGB64.ARGB64
 
   /**
-   * ARGB64 is the primary case class for representing colors in ARGB64 space.
+   * ARGB64 is the primary type for representing colors in ARGB64 space.
    *
    * @constructor Create a new ARGB64 object from an Int.
    * @see [[https://en.wikipedia.org/wiki/RGB_color_space]] for more information on the RGB color space.
    * @param argb a 64 bit integer that represents this color in ARGB64 space.
    *             The most significant byte encodes the alpha value, the second most significant byte encodes red,
    *             the third most significant byte encodes green, and the least significant byte encodes blue.
-   * @return an instance of the ARGB64 case class.
+   * @return an instance of the ARGB64 type.
    * @example {{{
    * val c = ARGB(-1)  // returns fully opaque white
    * c.toString()  // returns "ARGB(65535,65535,65535,65535)"
@@ -152,7 +152,6 @@ trait ARGB64 extends DiscreteRGB { self: WorkingSpace =>
    */
   given DiscreteRGB[ARGB64] with {
     extension (argb: ARGB64) {
-      //case class ARGB64(argb: Long) extends DiscreteRGB[ARGB64] {
       /**
        * @return the alpha component of this color in ARGB64 space.
        */
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/DiscreteRGB.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/DiscreteRGB.scala
@@ -70,7 +70,6 @@ trait DiscreteRGB {
     lazy val DarkGray: C = gray(MAX / 4)
     lazy val LightGray: C = gray((3 * MAX) / 4)
 
-    // abstract
     def apply(red: Int, green: Int, blue: Int): C
 
     def apply(c1: Int, c2: Int, c3: Int, c4: Int): C
@@ -87,7 +86,6 @@ trait DiscreteRGB {
       (clamp(c4) << 24) | (clamp(c3) << 16) | (clamp(c2) << 8) | clamp(c1)
     }
 
-    // abstract
     inline def clamp(red: Double, green: Double, blue: Double): Int
   }
 
@@ -112,7 +110,6 @@ trait DiscreteRGB {
       else None
     }
 
-    // abstract
     def clamp(red: Double, green: Double, blue: Double): Long
   }
 
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/RGBA32.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/RGBA32.scala
@@ -228,19 +228,6 @@ trait RGBA32 extends DiscreteRGB { self: WorkingSpace =>
 
       override def similarity(that: RGBA32): Double = RGBA32.similarity(rgba, that)
 
-//      /**
-//       * @return the hashcode.  For all color types, the hashcode function returns the same result as rgba
-//       */
-//      override def hashCode(): Int = rgba.asInstanceOf[Int]
-//
-//      /**
-//       * @return true if these colors are equal in RGBA space, false otherwise
-//       */
-//      def equals(obj: Any): Boolean = obj match {
-//        case that: RGBA32 => rgba == that
-//        case _ => false
-//      }
-
       /**
        * @return a hexadecimal string representing the rgba integer for this color.
        * @example {{{
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/RGBA64.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/rgb/discrete/RGBA64.scala
@@ -139,14 +139,14 @@ trait RGBA64 extends DiscreteRGB { self: WorkingSpace =>
   type RGBA64 = RGBA64.RGBA64
 
   /**
-   * RGBA64 is the primary case class for representing colors in RGBA64 space.
+   * RGBA64 is the primary type for representing colors in RGBA64 space.
    *
    * @constructor Create a new RGBA64 object from an Int.
    * @see [[https://en.wikipedia.org/wiki/RGB_color_space]] for more information on the RGB color space.
    * @param rgba a 64 bit integer that represents this color in RGBA64 space.
    *             The most significant byte encodes the alpha value, the second most significant byte encodes red,
    *             the third most significant byte encodes green, and the least significant byte encodes blue.
-   * @return an instance of the RGBA64 case class.
+   * @return an instance of the RGBA64 type.
    * @example {{{
    * val c = RGBA64(-1)  // returns fully opaque white
    * c.toString()  // returns "RGBA64(65535,65535,65535,65535)"
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/subtractive/CMY.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/subtractive/CMY.scala
@@ -61,8 +61,6 @@ trait CMY { self: WorkingSpace =>
       )
     )
 
-
-
     def cyan(cmy: CMY): Double = cmy(0)
 
     def magenta(cmy: CMY): Double = cmy(1)
@@ -101,7 +99,7 @@ trait CMY { self: WorkingSpace =>
   type CMY = CMY.CMY
 
   /**
-   * CMY is the primary case class for representing colors in CMY space.
+   * CMY is the primary type for representing colors in CMY space.
    *
    * @constructor Create a new CMY object from three Double values.  This constructor does not validate input parameters.
    *              For values taken from user input, sensors, or otherwise uncertain sources, consider using the factory method in the Color companion object.
@@ -110,7 +108,7 @@ trait CMY { self: WorkingSpace =>
    * @param cyan    a value ranging from [0-1].  Values outside of this range may cause errors.
    * @param magenta a value ranging from [0-1].  Values outside of this range may cause errors.
    * @param yellow  a value ranging from [0-1].  Values outside of this range may cause errors.
-   * @return an instance of the CMY case class.
+   * @return an instance of the CMY type.
    * @example {{{
    * val c = CMY(1f, 0.25f, 0.5f, 0f)
    * c.toString()  // returns "CMY(1.000,0.250,0.500,0.000)"
@@ -119,8 +117,6 @@ trait CMY { self: WorkingSpace =>
 
   given VectorColorModel[CMY] with {
     extension (cmy: CMY) {
-      //  case class CMY private(override val values: NArray[Double]) extends VectorColorModel[CMY] {
-      //    override type VEC = this.type with CMY
 
       def cyan: Double = CMY.cyan(cmy)
 
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/subtractive/CMYK.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/model/subtractive/CMYK.scala
@@ -123,7 +123,7 @@ trait CMYK { self: WorkingSpace =>
   }
 
   /**
-   * CMYK is the primary case class for representing colors in CMYK space.
+   * CMYK is the primary type for representing colors in CMYK space.
    *
    * @constructor Create a new CMYK object from three Double values.  This constructor does not validate input parameters.
    *              For values taken from user input, sensors, or otherwise uncertain sources, consider using the factory method in the Color companion object.
@@ -133,7 +133,7 @@ trait CMYK { self: WorkingSpace =>
    * @param magenta a value ranging from [0-1].  Values outside of this range may cause errors.
    * @param yellow  a value ranging from [0-1].  Values outside of this range may cause errors.
    * @param key   a value ranging from [0-1].  Values outside of this range may cause errors.
-   * @return an instance of the CMYK case class.
+   * @return an instance of the CMYK type.
    * @example {{{
    * val c = CMYK(1f, 0.25f, 0.5f, 0f)
    * c.toString()  // returns "CMYK(1.000,0.250,0.500,0.000)"
@@ -144,8 +144,6 @@ trait CMYK { self: WorkingSpace =>
 
   given VectorColorModel[CMYK] with {
     extension (cmyk: CMYK) {
-      //  case class CMYK private(override val values: NArray[Double]) extends VectorColorModel[CMYK] {
-      //    override type VEC = this.type with CMYK
 
       def cyan: Double = CMYK.cyan(cmyk)
 
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/spectral/SampleSet.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/color/spectral/SampleSet.scala
@@ -28,7 +28,6 @@ trait SampleSet {
 
   lazy val volumePoints:NArray[Vec[3]] = {
 
-    //val points: NArray[Vec[3]] = new NArray[Vec[3]](squareInPlace(samples.length))
     val points: NArray[Vec[3]] = NArray.ofSize[Vec[3]](
       2 + (samples.length * (samples.length - 1))
     )
@@ -56,18 +55,6 @@ trait SampleSet {
       }
     }
 
-//    println(s"${points.length} vs $p")
-//
-//    // normalize:
-//    for (i <- points.indices) {
-//      val xyz: Vec[3] = points(i)
-//      points(i) =  Vec[3](
-//        xyz.x / sv.maxValues(0),
-//        xyz.y / sv.maxValues(1),
-//        xyz.z / sv.maxValues(2)
-//      )
-//    }
-
     points
   }
 }
diff --git a/uriel/shared/src/main/scala/ai/dragonfly/uriel/verification/ConversionFidelity.scala b/uriel/shared/src/main/scala/ai/dragonfly/uriel/verification/ConversionFidelity.scala
@@ -18,6 +18,10 @@ package ai.dragonfly.uriel.verification
 
 import ai.dragonfly.uriel.ColorContext
 
+/**
+ * ConversionFidelity converts every RGBA color to every other color model and back, for all color spaces to verify correctness.
+ */
+
 object ConversionFidelity {
   def main(args: Array[String]):Unit = {
     for (ctx <- ColorContext.knownContexts) {

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ trait HSL extends HueSaturation { self: WorkingSpace =>`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`44`		`- * HSL is the primary case class for representing colors in HSL space.`
	`44`	`+ * HSL is the primary type for representing colors in HSL space.`
`45`	`45`	`*`
`46`	`46`	`* @constructor Create a new HSV object from three Double values. This constructor does not validate input parameters.`
`47`	`47`	`* For values taken from user input, sensors, or otherwise uncertain sources, consider using the factory method in the Color companion object.`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ trait HSV extends HueSaturation { self: WorkingSpace =>`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`44`		`- * HSV is the primary case class for representing colors in HSV space.`
	`44`	`+ * HSV is the primary type for representing colors in HSV space.`
`45`	`45`	`*`
`46`	`46`	`* @constructor Create a new HSV object from three Double values. This constructor does not validate`
`47`	`47`	`* input parameters. For values taken from user input, sensors, or otherwise uncertain sources, consider using`
Original file line number	Diff line number	Diff line change
`@@ -103,10 +103,6 @@ trait Luv { self: WorkingSpace =>`
`103`	`103`	`)`
`104`	`104`	`}`
`105`	`105`
`106`		`-// override val rgbGamut:Gamut = Gamut.fromRGB(transform = (v:XYZ) => Vector3(fromXYZ(v).values))`
`107`		`-`
`108`		`- // override def toString:String = s"${illuminant}Luv*"`
`109`		`-`
`110`	`106`	`def L(luv: Luv): Double = luv(2)`
`111`	`107`
`112`	`108`	`def u(luv: Luv): Double = luv(0)`
`@@ -121,14 +117,11 @@ trait Luv { self: WorkingSpace =>`
`121`	`117`	`}`
`122`	`118`
`123`	`119`	`/**`
`124`		`- * LUV is the base trait for classes that encode colors in the CIE Luv* color space.`
	`120`	`+ * LUV is the primary type to represent colors from the CIE Luv* color space.`
`125`	`121`	`*`
`126`	`122`	`* @see [[https://en.wikipedia.org/wiki/CIELUV]] for more information on CIE Luv*.`
`127`	`123`	`*/`
`128`	`124`
`129`		`-// case class Luv private(override val values: NArray[Double]) extends PerceptualColorModel[Luv] {`
`130`		`-// override type VEC = this.type with Luv`
`131`		`-`
`132`	`125`	`type Luv = Luv.Luv`
`133`	`126`
`134`	`127`	`given PerceptualColorModel[Luv] with {`