Legacy color convert update to use new methods

4dev/tests/Convert/CoreLibsConvertColorsTest.php

@@ -9,7 +9,7 @@ use PHPUnit\Framework\TestCase;
 /**
  * Test class for Convert\Colors
  * @coversDefaultClass \CoreLibs\Convert\Colors
- * @testdox \CoreLibs\Convert\Colors method tests
+ * @testdox \CoreLibs\Convert\Colors legacy method tests
  */
 final class CoreLibsConvertColorsTest extends TestCase
 {
@@ -21,7 +21,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 *
 	 * @return array
 	 */
-	public function rgb2hexColorProvider(): array
+	public function providerRgb2hexColor(): array
 	{
 		return [
 			'color' => [
@@ -88,7 +88,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 *
 	 * @return array
 	 */
-	public function hex2rgbColorProvider(): array
+	public function providerHex2rgbColor(): array
 	{
 		return [
 			'color' => [
@@ -215,7 +215,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 *
 	 * @return array
 	 */
-	public function rgb2hsbColorProvider(): array
+	public function providerRgb2hsbColor(): array
 	{
 		$list = [];
 		foreach ($this->rgb2hslAndhsbList() as $name => $values) {
@@ -234,7 +234,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 *
 	 * @return array
 	 */
-	public function hsb2rgbColorProvider(): array
+	public function providerHsb2rgbColor(): array
 	{
 		$list = [];
 		foreach ($this->rgb2hslAndhsbList() as $name => $values) {
@@ -253,7 +253,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 *
 	 * @return array
 	 */
-	public function rgb2hslColorProvider(): array
+	public function providerRgb2hslColor(): array
 	{
 		$list = [];
 		foreach ($this->rgb2hslAndhsbList() as $name => $values) {
@@ -272,7 +272,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 *
 	 * @return array
 	 */
-	public function hsl2rgbColorProvider(): array
+	public function providerHsl2rgbColor(): array
 	{
 		$list = [];
 		foreach ($this->rgb2hslAndhsbList() as $name => $values) {
@@ -291,7 +291,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 * TODO: add cross convert check
 	 *
 	 * @covers ::rgb2hex
-	 * @dataProvider rgb2hexColorProvider
+	 * @dataProvider providerRgb2hexColor
 	 * @testdox rgb2hex $input_r,$input_g,$input_b will be $expected [$_dataName]
 	 *
 	 * @param int $input_r
@@ -342,7 +342,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @covers ::hex2rgb
-	 * @dataProvider hex2rgbColorProvider
+	 * @dataProvider providerHex2rgbColor
 	 * @testdox hex2rgb $input will be $expected, $expected_str str[,], $expected_str_sep str[$separator] [$_dataName]
 	 *
 	 * @param string $input
@@ -385,7 +385,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @covers ::rgb2hsb
-	 * @dataProvider rgb2hsbColorProvider
+	 * @dataProvider providerRgb2hsbColor
 	 * @testdox rgb2hsb $input_r,$input_g,$input_b will be $expected [$_dataName]
 	 *
 	 * @param integer $input_r
@@ -409,7 +409,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @covers ::hsb2rgb
-	 * @dataProvider hsb2rgbColorProvider
+	 * @dataProvider providerHsb2rgbColor
 	 * @testdox hsb2rgb $input_h,$input_s,$input_b will be $expected [$_dataName]
 	 *
 	 * @param float $input_h
@@ -434,7 +434,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @covers ::rgb2hsl
-	 * @dataProvider rgb2hslColorProvider
+	 * @dataProvider providerRgb2hslColor
 	 * @testdox rgb2hsl $input_r,$input_g,$input_b will be $expected [$_dataName]
 	 *
 	 * @param integer $input_r
@@ -458,7 +458,7 @@ final class CoreLibsConvertColorsTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @covers ::hsl2rgb
-	 * @dataProvider hsl2rgbColorProvider
+	 * @dataProvider providerHsl2rgbColor
 	 * @testdox hsl2rgb $input_h,$input_s,$input_l will be $expected [$_dataName]
 	 *
 	 * @param integer|float $input_h

4dev/tests/Convert/CoreLibsConvertMathTest.php

@@ -18,7 +18,7 @@ final class CoreLibsConvertMathTest extends TestCase
 	 *
 	 * @return array<mixed>
 	 */
-	public function fceilProvider(): array
+	public function providerFceil(): array
 	{
 		return [
 			'5.5 must be 6' => [5.5, 6],
@@ -31,7 +31,7 @@ final class CoreLibsConvertMathTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @covers ::fceil
-	 * @dataProvider fceilProvider
+	 * @dataProvider providerFceil
 	 * @testdox fceil: Input $input must be $expected
 	 *
 	 * @param float $input
@@ -51,7 +51,7 @@ final class CoreLibsConvertMathTest extends TestCase
 	 *
 	 * @return array<mixed>
 	 */
-	public function floorProvider(): array
+	public function providerFloor(): array
 	{
 		return [
 			'5123456 with -3 must be 5123000' => [5123456, -3, 5123000],
@@ -63,7 +63,7 @@ final class CoreLibsConvertMathTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @covers ::floorp
-	 * @dataProvider floorProvider
+	 * @dataProvider providerFloor
 	 * @testdox floor: Input $input with cutoff $cutoff must be $expected
 	 *
 	 * @param int $input
@@ -84,7 +84,7 @@ final class CoreLibsConvertMathTest extends TestCase
 	 *
 	 * @return array<mixed>
 	 */
-	public function initNumericProvider(): array
+	public function providerInitNumeric(): array
 	{
 		return [
 			'5 must be 5' => [5, 5, 'int'],
@@ -98,7 +98,7 @@ final class CoreLibsConvertMathTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @covers ::initNumeric
-	 * @dataProvider initNumericProvider
+	 * @dataProvider providerInitNumeric
 	 * @testdox initNumeric: Input $info $input must match $expected [$_dataName]
 	 *
 	 * @param int|float|string $input
@@ -114,7 +114,156 @@ final class CoreLibsConvertMathTest extends TestCase
 		);
 	}
 
-	// TODO: cbrt tests
+	/**
+	 * Undocumented function
+	 *
+	 * @return array
+	 */
+	public function providerCbrt(): array
+	{
+		return [
+			'cube root of 2' => [2, 1.25992, 5],
+			'cube root of 3' => [3, 1.44225, 5],
+			'cube root of -1' => [-1, 'NAN', 0],
+		];
+	}
+
+	/**
+	 * Undocumented function
+	 *
+	 * @covers ::cbrt
+	 * @dataProvider providerCbrt
+	 * @testdox initNumeric: Input $input must match $expected [$_dataName]
+	 *
+	 * @param  float|int $number
+	 * @param  float     $expected
+	 * @param  int       $round_to
+	 * @return void
+	 */
+	public function testCbrt(float|int $number, float|string $expected, int $round_to): void
+	{
+		print "OUT: " . \CoreLibs\Convert\Math::cbrt($number) . "\n";
+		$this->assertEquals(
+			$expected,
+			round(\CoreLibs\Convert\Math::cbrt($number), $round_to)
+		);
+	}
+
+	/**
+	 * Undocumented function
+	 *
+	 * @return array
+	 */
+	public function providerMultiplyMatrices(): array
+	{
+		return  [
+			'single' => [
+				[1, 2, 3],
+				[1, 2, 3],
+				[14]
+			],
+			'double first' => [
+				[
+					[1, 2, 3],
+					[1, 2, 3]
+				],
+				[1, 2, 3],
+				[
+					14,
+					14
+				]
+			],
+			'double both' => [
+				[
+					[1, 2, 3],
+					[1, 2, 3],
+				],
+				[
+					[1, 2, 3],
+					[1, 2, 3],
+				],
+				[
+					[3, 6, 9],
+					[3, 6, 9]
+				]
+			],
+			'tripple first, single second' => [
+				[
+					[1, 2, 3],
+					[1, 2, 3],
+					[1, 2, 3],
+				],
+				[1, 2, 3],
+				[
+					14,
+					14,
+					14
+				]
+			],
+			'tripple first, double second' => [
+				[
+					[1, 2, 3],
+					[1, 2, 3],
+					[1, 2, 3],
+				],
+				[
+					[1, 2, 3],
+					[1, 2, 3],
+				],
+				[
+					[3, 6, 9],
+					[3, 6, 9],
+					[3, 6, 9],
+				]
+			],
+			'single first, tripple second' => [
+				[1, 2, 3],
+				[
+					[1, 2, 3],
+					[1, 2, 3],
+					[1, 2, 3],
+				],
+				[
+					[6, 12, 18],
+				]
+			],
+			'double first, tripple second' => [
+				[
+					[1, 2, 3],
+					[1, 2, 3],
+				],
+				[
+					[1, 2, 3],
+					[1, 2, 3],
+					[1, 2, 3],
+				],
+				[
+					[6, 12, 18],
+					[6, 12, 18],
+				]
+			],
+		];
+	}
+
+	/**
+	 * Undocumented function
+	 *
+	 * @covers ::multiplyMatrices
+	 * @dataProvider providerMultiplyMatrices
+	 * @testdox initNumeric: Input $input_a x $input_b must match $expected [$_dataName]
+	 *
+	 * @param  array $input_a
+	 * @param  array $input_b
+	 * @param  array $expected
+	 * @return void
+	 */
+	public function testMultiplyMatrices(array $input_a, array $input_b, array $expected): void
+	{
+		$this->assertEquals(
+			$expected,
+			\CoreLibs\Convert\Math::multiplyMatrices($input_a, $input_b)
+		);
+	}
 }
 
 // __END__

www/lib/CoreLibs/Convert/Colors.php

@@ -41,20 +41,6 @@ class Colors
 		bool $hex_prefix = true
 	): string {
 		return Coordinates\RGB::__constructFromArray([$red, $green, $blue])->returnAsHex($hex_prefix);
-		/* $hex_color = '';
-		if ($hex_prefix === true) {
-			$hex_color = '#';
-		}
-		foreach (['red', 'green', 'blue'] as $color) {
-			// if not valid, abort
-			if ($$color < 0 || $$color > 255) {
-				throw new \LengthException('Argument value ' . $$color . ' for color ' . $color
-					. ' is not in the range of 0 to 255', 1);
-			}
-			// pad left with 0
-			$hex_color .= str_pad(dechex($$color), 2, '0', STR_PAD_LEFT);
-		}
-		return $hex_color; */
 	}
 
 	/**
@@ -73,28 +59,22 @@ class Colors
 		bool $return_as_string = false,
 		string $seperator = ','
 	): string|array {
-		/* $hex_string = preg_replace("/[^0-9A-Fa-f]/", '', $hex_string); // Gets a proper hex string
-		if (!is_string($hex_string)) {
-			throw new \InvalidArgumentException('hex_string argument cannot be empty', 1);
-		}
 		$rgbArray = [];
-		if (strlen($hex_string) == 6) {
-			// If a proper hex code, convert using bitwise operation.
-			// No overhead... faster
-			$colorVal = hexdec($hex_string);
-			$rgbArray['r'] = 0xFF & ($colorVal >> 0x10);
-			$rgbArray['g'] = 0xFF & ($colorVal >> 0x8);
-			$rgbArray['b'] = 0xFF & $colorVal;
-		} elseif (strlen($hex_string) == 3) {
-			// If shorthand notation, need some string manipulations
-			$rgbArray['r'] = hexdec(str_repeat(substr($hex_string, 0, 1), 2));
-			$rgbArray['g'] = hexdec(str_repeat(substr($hex_string, 1, 1), 2));
-			$rgbArray['b'] = hexdec(str_repeat(substr($hex_string, 2, 1), 2));
-		} else {
-			// Invalid hex color code
-			throw new \UnexpectedValueException('Invalid hex_string: ' . $hex_string, 2);
-		} */
-		$rgbArray = Coordinates\RGB::__constructFromHexString($hex_string)->returnAsArray();
+		// rewrite to previous r/g/b key output
+		foreach (Coordinates\RGB::__constructFromHexString($hex_string)->returnAsArray() as $p => $el) {
+			switch ($p) {
+				case 0:
+					$k = 'r';
+					break;
+				case 1:
+					$k = 'g';
+					break;
+				case 2:
+					$k = 'b';
+					break;
+			}
+			$rgbArray[$k] = (int)round($el);
+		}
 		// returns the rgb string or the associative array
 		return $return_as_string ? implode($seperator, $rgbArray) : $rgbArray;
 	}
@@ -113,45 +93,12 @@ class Colors
 	 */
 	public static function rgb2hsb(int $red, int $green, int $blue): array
 	{
-		return Color::rgbToHsb(
-			Coordinates\RGB::__constructFromArray([$red, $green, $blue])
-		)->returnAsArray();
-		/* // check that rgb is from 0 to 255
-		foreach (['red', 'green', 'blue'] as $color) {
-			if ($$color < 0 || $$color > 255) {
-				throw new \LengthException('Argument value ' . $$color . ' for color ' . $color
-					. ' is not in the range of 0 to 255', 1);
-			}
-			$$color = $$color / 255;
-		}
-
-		$MAX = max($red, $green, $blue);
-		$MIN = min($red, $green, $blue);
-		$HUE = 0;
-		$DELTA = $MAX - $MIN;
-
-		// achromatic
-		if ($MAX == $MIN) {
-			return [0, 0, round($MAX * 100)];
-		}
-		if ($red == $MAX) {
-			$HUE = fmod(($green - $blue) / $DELTA, 6);
-		} elseif ($green == $MAX) {
-			$HUE = (($blue - $red) / $DELTA) + 2;
-		} elseif ($blue == $MAX) {
-			$HUE = (($red - $green) / $DELTA) + 4;
-		}
-		$HUE *= 60;
-		// avoid negative
-		if ($HUE < 0) {
-			$HUE += 360;
-		}
-
-		return [
-			(int)round($HUE), // Hue
-			(int)round(($DELTA / $MAX) * 100), // Saturation
-			(int)round($MAX * 100) // Value/Brightness
-		]; */
+		return array_map(
+			fn ($v) => (int)round($v),
+			Color::rgbToHsb(
+				Coordinates\RGB::__constructFromArray([$red, $green, $blue])
+			)->returnAsArray()
+		);
 	}
 
 	/**
@@ -167,81 +114,12 @@ class Colors
 	 */
 	public static function hsb2rgb(float $H, float $S, float $V): array
 	{
-		return Color::hsbToRgb(
-			Coordinates\HSB::__constructFromArray([$H, $S, $V])
-		)->returnAsArray();
-
-		/* // check that H is 0 to 359, 360 = 0
-		// and S and V are 0 to 1
-		if ($H == 360) {
-			$H = 0;
-		}
-		if ($H < 0 || $H > 359) {
-			throw new \LengthException('Argument value ' . $H . ' for hue is not in the range of 0 to 359', 1);
-		}
-		if ($S < 0 || $S > 100) {
-			throw new \LengthException('Argument value ' . $S . ' for saturation is not in the range of 0 to 100', 2);
-		}
-		if ($V < 0 || $V > 100) {
-			throw new \LengthException('Argument value ' . $V . ' for brightness is not in the range of 0 to 100', 3);
-		}
-		// convert to internal 0-1 format
-		$S /= 100;
-		$V /= 100;
-
-		if ($S == 0) {
-			$V = (int)round($V * 255);
-			return [$V, $V, $V];
-		}
-
-		$Hi = floor($H / 60);
-		$f = ($H / 60) - $Hi;
-		$p = $V * (1 - $S);
-		$q = $V * (1 - ($S * $f));
-		$t = $V * (1 - ($S * (1 - $f)));
-
-		switch ($Hi) {
-			case 0:
-				$red = $V;
-				$green = $t;
-				$blue = $p;
-				break;
-			case 1:
-				$red = $q;
-				$green = $V;
-				$blue = $p;
-				break;
-			case 2:
-				$red = $p;
-				$green = $V;
-				$blue = $t;
-				break;
-			case 3:
-				$red = $p;
-				$green = $q;
-				$blue = $V;
-				break;
-			case 4:
-				$red = $t;
-				$green = $p;
-				$blue = $V;
-				break;
-			case 5:
-				$red = $V;
-				$green = $p;
-				$blue = $q;
-				break;
-			default:
-				$red = 0;
-				$green = 0;
-				$blue = 0;
-		}
-
-		return [
-			(int)round($red * 255),
-			(int)round($green * 255),
-			(int)round($blue * 255)
-		]; */
+		return array_map(
+			fn ($v) => (int)round($v),
+			Color::hsbToRgb(
+				Coordinates\HSB::__constructFromArray([$H, $S, $V])
+			)->returnAsArray()
+		);
 	}
 
 	/**
@@ -257,51 +135,12 @@ class Colors
 	 */
 	public static function rgb2hsl(int $red, int $green, int $blue): array
 	{
-		return Color::rgbToHsl(
-			Coordinates\RGB::__constructFromArray([$red, $green, $blue])
-		)->returnAsArray();
-
-		/* // check that rgb is from 0 to 255
-		foreach (['red', 'green', 'blue'] as $color) {
-			if ($$color < 0 || $$color > 255) {
-				throw new \LengthException('Argument value ' . $$color . ' for color ' . $color
-					. ' is not in the range of 0 to 255', 1);
-			}
-			$$color = $$color / 255;
-		}
-
-		$min = min($red, $green, $blue);
-		$max = max($red, $green, $blue);
-		$chroma = $max - $min;
-		$sat = 0;
-		$hue = 0;
-		// luminance
-		$lum = ($max + $min) / 2;
-
-		// achromatic
-		if ($chroma == 0) {
-			// H, S, L
-			return [0.0, 0.0, round($lum * 100, 1)];
-		} else {
-			$sat = $chroma / (1 - abs(2 * $lum - 1));
-			if ($max == $red) {
-				$hue = fmod((($green - $blue) / $chroma), 6);
-				if ($hue < 0) {
-					$hue = (6 - fmod(abs($hue), 6));
-				}
-			} elseif ($max == $green) {
-				$hue = ($blue - $red) / $chroma + 2;
-			} elseif ($max == $blue) {
-				$hue = ($red - $green) / $chroma + 4;
-			}
-			$hue = $hue * 60;
-			// $sat = 1 - abs(2 * $lum - 1);
-			return [
-				round($hue, 1),
-				round($sat * 100, 1),
-				round($lum * 100, 1)
-			];
-		} */
+		return array_map(
+			fn ($v) => round($v, 1),
+			Color::rgbToHsl(
+				Coordinates\RGB::__constructFromArray([$red, $green, $blue])
+			)->returnAsArray()
+		);
 	}
 
 	/**
@@ -316,58 +155,12 @@ class Colors
 	 */
 	public static function hsl2rgb(float $hue, float $sat, float $lum): array
 	{
-		return Color::hslToRgb(
-			Coordinates\HSL::__constructFromArray([$hue, $sat, $lum])
-		)->returnAsArray();
-
-		/* if ($hue == 360) {
-			$hue = 0;
-		}
-		if ($hue < 0 || $hue > 359) {
-			throw new \LengthException('Argument value ' . $hue . ' for hue is not in the range of 0 to 359', 1);
-		}
-		if ($sat < 0 || $sat > 100) {
-			throw new \LengthException('Argument value ' . $sat . ' for saturation is not in the range of 0 to 100', 2);
-		}
-		if ($lum < 0 || $lum > 100) {
-			throw new \LengthException('Argument value ' . $lum . ' for luminance is not in the range of 0 to 100', 3);
-		}
-		// calc to internal convert value for hue
-		$hue = (1 / 360) * $hue;
-		// convert to internal 0-1 format
-		$sat /= 100;
-		$lum /= 100;
-		// if saturation is 0
-		if ($sat == 0) {
-			$lum = (int)round($lum * 255);
-			return [$lum, $lum, $lum];
-		} else {
-			$m2 = $lum < 0.5 ? $lum * ($sat + 1) : ($lum + $sat) - ($lum * $sat);
-			$m1 = $lum * 2 - $m2;
-			$hueue = function ($base) use ($m1, $m2) {
-				// base = hue, hue > 360 (1) - 360 (1), else < 0 + 360 (1)
-				$base = $base < 0 ? $base + 1 : ($base > 1 ? $base - 1 : $base);
-				// 6: 60, 2: 180, 3: 240
-				// 2/3 = 240
-				// 1/3 = 120 (all from 360)
-				if ($base * 6 < 1) {
-					return $m1 + ($m2 - $m1) * $base * 6;
-				}
-				if ($base * 2 < 1) {
-					return $m2;
-				}
-				if ($base * 3 < 2) {
-					return $m1 + ($m2 - $m1) * ((2 / 3) - $base) * 6;
-				}
-				return $m1;
-			};
-
-			return [
-				(int)round(255 * $hueue($hue + (1 / 3))),
-				(int)round(255 * $hueue($hue)),
-				(int)round(255 * $hueue($hue - (1 / 3)))
-			];
-		} */
+		return array_map(
+			fn ($v) => round($v),
+			Color::hslToRgb(
+				Coordinates\HSL::__constructFromArray([$hue, $sat, $lum])
+			)->returnAsArray()
+		);
 	}
 }
 

www/lib/CoreLibs/Convert/Math.php

@@ -63,9 +63,9 @@ class Math
 	 * @param  float $number Number to cubic root
 	 * @return float         Calculated value
 	 */
-	public static function cbrt(float $number): float
+	public static function cbrt(float|int $number): float
 	{
-		return pow($number, 1.0 / 3);
+		return pow((float)$number, 1.0 / 3);
 	}
 
 	/**