Add Random\Randomizer\GetFloatBounds

Author: TimWolla

ext/random/php_random.h

@@ -268,7 +268,9 @@ extern PHPAPI zend_class_entry *random_ce_Random_Engine_PcgOneseq128XslRr64;
 extern PHPAPI zend_class_entry *random_ce_Random_Engine_Mt19937;
 extern PHPAPI zend_class_entry *random_ce_Random_Engine_Xoshiro256StarStar;
 extern PHPAPI zend_class_entry *random_ce_Random_Engine_Secure;
+
 extern PHPAPI zend_class_entry *random_ce_Random_Randomizer;
+extern PHPAPI zend_class_entry *random_ce_Random_Randomizer_GetFloatBounds;
 
 static inline php_random_engine *php_random_engine_from_obj(zend_object *object) {
 	return (php_random_engine *)((char *)(object) - XtOffsetOf(php_random_engine, std));

ext/random/random.c

@@ -26,6 +26,7 @@
 
 #include "php.h"
 
+#include "Zend/zend_enum.h"
 #include "Zend/zend_exceptions.h"
 
 #include "php_random.h"
@@ -75,6 +76,7 @@ PHPAPI zend_class_entry *random_ce_Random_Engine_Xoshiro256StarStar;
 PHPAPI zend_class_entry *random_ce_Random_Engine_Secure;
 
 PHPAPI zend_class_entry *random_ce_Random_Randomizer;
+PHPAPI zend_class_entry *random_ce_Random_Randomizer_GetFloatBounds;
 
 PHPAPI zend_class_entry *random_ce_Random_RandomError;
 PHPAPI zend_class_entry *random_ce_Random_BrokenRandomEngineError;
@@ -898,6 +900,9 @@ PHP_MINIT_FUNCTION(random)
 	random_randomizer_object_handlers.free_obj = randomizer_free_obj;
 	random_randomizer_object_handlers.clone_obj = NULL;
 
+	/* Random\Randomizer\GetFloatBounds */
+	random_ce_Random_Randomizer_GetFloatBounds = register_class_Random_Randomizer_GetFloatBounds();
+
 	register_random_symbols(module_number);
 
 	return SUCCESS;

ext/random/random.stub.php

@@ -111,6 +111,14 @@ public function generate(): string {}
     }
 }
 
+namespace Random\Randomizer
+{
+    enum GetFloatBounds {
+        case ClosedOpen;
+        case ClosedClosed;
+    }
+}
+
 namespace Random
 {
     interface Engine
@@ -135,7 +143,7 @@ public function nextInt(): int {}
 
         public function nextFloat(): float {}
 
-        public function getFloat(float $min, float $max): float {}
+        public function getFloat(float $min, float $max, Randomizer\GetFloatBounds $bounds = GetFloatBounds::ClosedOpen): float {}
 
         public function getInt(int $min, int $max): int {}
 

ext/random/random_arginfo.h

@@ -24,6 +24,7 @@
 #include "ext/standard/php_array.h"
 #include "ext/standard/php_string.h"
 
+#include "Zend/zend_enum.h"
 #include "Zend/zend_exceptions.h"
 
 static inline void randomizer_common_init(php_random_randomizer *randomizer, zend_object *engine_object) {
@@ -160,6 +161,32 @@ static uint64_t getFloat_ceilint(double a, double b, double g)
 	return (s != si) ? (uint64_t)si : (uint64_t)si + (e > 0);
 }
 
+static double getFloat_closed_open(const php_random_algo *algo, php_random_status *status, double min, double max)
+{
+	double g = getFloat_gamma(min, max);
+	uint64_t hi = getFloat_ceilint(min, max, g);
+	uint64_t k = algo->range(status, 1, hi);
+
+	if (fabs(min) <= fabs(max)) {
+		return k == hi ? min : max - k * g;
+	} else {
+		return min + (k - 1) * g;
+	}
+}
+
+static double getFloat_closed_closed(const php_random_algo *algo, php_random_status *status, double min, double max)
+{
+	double g = getFloat_gamma(min, max);
+	uint64_t hi = getFloat_ceilint(min, max, g);
+	uint64_t k = algo->range(status, 0, hi);
+
+	if (fabs(min) <= fabs(max)) {
+		return k == hi ? min : max - k * g;
+	} else {
+		return k == hi ? max : min + k * g;
+	}
+}
+
 /* {{{ Generates a random float within [min, max).
  *
  * The algorithm used is the γ-section algorithm as published in:
@@ -172,10 +199,14 @@ PHP_METHOD(Random_Randomizer, getFloat)
 {
 	php_random_randomizer *randomizer = Z_RANDOM_RANDOMIZER_P(ZEND_THIS);
 	double min, max;
+	zend_object *bounds = NULL;
+	zend_string *bounds_name = zend_string_init("ClosedOpen", strlen("ClosedOpen"), 1);
 
-	ZEND_PARSE_PARAMETERS_START(2, 2)
+	ZEND_PARSE_PARAMETERS_START(2, 3)
 		Z_PARAM_DOUBLE(min)
 		Z_PARAM_DOUBLE(max)
+		Z_PARAM_OPTIONAL
+		Z_PARAM_OBJ_OF_CLASS(bounds, random_ce_Random_Randomizer_GetFloatBounds);
 	ZEND_PARSE_PARAMETERS_END();
 
 #ifndef __STDC_IEC_559__
@@ -188,15 +219,18 @@ PHP_METHOD(Random_Randomizer, getFloat)
 		RETURN_THROWS();
 	}
 
-	double g = getFloat_gamma(min, max);
-	uint64_t hi = getFloat_ceilint(min, max, g);
-	uint64_t k = randomizer->algo->range(randomizer->status, 1, hi);
-
-	if (fabs(min) <= fabs(max)) {
-		RETURN_DOUBLE(k == hi ? min : max - k * g);
-	} else {
-		RETURN_DOUBLE(min + (k - 1) * g);
+	if (bounds) {
+		zval *case_name = zend_enum_fetch_case_name(bounds);
+		bounds_name = Z_STR_P(case_name);
+	}
+	
+	if (zend_string_equals_literal(bounds_name, "ClosedOpen")) {
+		RETURN_DOUBLE(getFloat_closed_open(randomizer->algo, randomizer->status, min, max));
+	}
+	if (zend_string_equals_literal(bounds_name, "ClosedClosed")) {
+		RETURN_DOUBLE(getFloat_closed_closed(randomizer->algo, randomizer->status, min, max));
 	}
+	ZEND_UNREACHABLE();
 }
 /* }}} */