rfc:random_extension_improvement

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
rfc:random_extension_improvement [2022/06/22 14:26] – update 1.5 zeriyoshirfc:random_extension_improvement [2022/07/22 09:55] (current) – reword two issues as the problem (VS the proposed solution) guilliamxavier
Line 1: Line 1:
 ====== PHP RFC: Random Extension Improvement ====== ====== PHP RFC: Random Extension Improvement ======
-  * Version: 1.5+  * Version: 1.5.4
   * Date: 2022-06-16   * Date: 2022-06-16
   * Author: Go Kudo <g-kudo@colopl.co.jp> <zeriyoshi@gmail.com>   * Author: Go Kudo <g-kudo@colopl.co.jp> <zeriyoshi@gmail.com>
-  * Status: Under Discussion+  * Status: Implemented
   * First Published at: http://wiki.php.net/rfc/rng_extension   * First Published at: http://wiki.php.net/rfc/rng_extension
  
 ===== Introduction ===== ===== Introduction =====
  
-There are several issues with RFC: Random Extension 5.x that are already in the voting phase due to lack of proper discussion. +Several issues with [[rfc:rng_extension|the "Random Extension 5.x" RFC]] were only raised after voting started (due to lack of proper discussion):
- +
-Key issues include:+
  
 ==== Engine implementations are not final ==== ==== Engine implementations are not final ====
  
-The Random Extension has classes that are natively implemented as RNG engines, but they are not marked as final.+The Random Extension has classes that are natively implemented as RNG engines, but they are not marked as <php>final</php>.
 This allows classes to be created that inherit from native classes, but as stated in the previous RFC, user-implemented engines are inferior to native classes in terms of execution efficiency. This is true even for inheritance without method overrides, which often leads to confusion. This allows classes to be created that inherit from native classes, but as stated in the previous RFC, user-implemented engines are inferior to native classes in terms of execution efficiency. This is true even for inheritance without method overrides, which often leads to confusion.
  
-The extension already provides a Random\Engine interface with a single generate(): string method.+The extension already provides a ''Random\Engine'' interface with a single ''generate(): string'' method.
 Even if the native classes are made final, it is easy for the user to create an alternative class using delegates. Even if the native classes are made final, it is easy for the user to create an alternative class using delegates.
  
 This is clearly an API design error, and the native implementations of the interface should be marked as final. This is clearly an API design error, and the native implementations of the interface should be marked as final.
  
-==== Random\SerializableEngine is outdated ====+==== Random\SerializableEngine is not useful ====
  
-This interface is a remnant from when the Serializable interface was still useful. This interface is no longer needed in PHP, as serializability is now determined by the existence of a magic method.+This interface is a remnant from when the <php>Serializable</php> interface was still useful. This interface is no longer needed in PHP, as serializability is now determined by the existence of a magic method.
  
-For this reason, remove RandomEngine\SerializableEngine.+For this reason, remove ''Random\SerializableEngine''.
  
 This means that an Engine that implements SerializableEngine will no longer implement it.  This means that an Engine that implements SerializableEngine will no longer implement it. 
 However, serializability is determined by the implementation of the magic method in current PHP, so it has no effect. However, serializability is determined by the implementation of the magic method in current PHP, so it has no effect.
  
-==== CombinedLCG is outdated ====+==== Random\Engine\CombinedLCG is low quality ====
  
-The newly added Random\Engine\CombinedLCG is only for use with PHP's lcg_value() function.+The newly added ''Random\Engine\CombinedLCG'' is only for use with PHP's <php>lcg_value()</php> function.
 However, this algorithm is very classical and the quality of the output random numbers is at the lowest level. However, this algorithm is very classical and the quality of the output random numbers is at the lowest level.
  
 In order to preserve the implementation of the lcg_value() function, the internal implementation is retained, but the implementation as a class is being dropped to prevent users from unintentionally using it. In order to preserve the implementation of the lcg_value() function, the internal implementation is retained, but the implementation as a class is being dropped to prevent users from unintentionally using it.
  
-==== Add Randomizer::pickArrayKeys(array $array, int $num): array method ====+==== There is no equivalent of array_rand() ====
  
-array_rand() uses RNG internally, but there is no alternative method in Randomizer.+<php>array_rand()</php> uses RNG internally, but there is no alternative method in ''Randomizer''.
 As per the previous RFC, this was the intent, but upon further investigation, array_rand() is used by many packages and should probably be drop-in replaceable. As per the previous RFC, this was the intent, but upon further investigation, array_rand() is used by many packages and should probably be drop-in replaceable.
  
-So add a method called Randomizer::pickArrayKeys(array $array, int $num): array. It looks incompatible with array_rand(), but you can get completely consistent results by doing the following:+So add a method <php>Randomizer::pickArrayKeys(array $array, int $num): array</php>. 
 + 
 +It may look incompatible with <php>array_rand(array $array, int $num = 1): int|string|array</php>, but you can get completely consistent results by doing the following:
  
 <code php> <code php>
 +$array = ['foo', 'bar', 'baz'];
 +
 +// Before:
 mt_srand(1234, MT_RAND_PHP); mt_srand(1234, MT_RAND_PHP);
-$beforeMultiple = array_rand(['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'], 2); // (array) ['bar', 'baz'] +$single = array_rand($array); // (int) 0 
-$beforeSingle = array_rand(['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'], 1); // (string) foo+$multiple = array_rand($array, 2); // (array) [1, 2]
  
 +// After:
 $engine = new Random\Engine\Mt19937(1234, MT_RAND_PHP); $engine = new Random\Engine\Mt19937(1234, MT_RAND_PHP);
 $randomizer = new Random\Randomizer($engine); $randomizer = new Random\Randomizer($engine);
-$beforeMultiple = $randomizer->pickArrayKeys(['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'], 2); // (array) ['bar', 'baz'] +$single = $randomizer->pickArrayKeys($array, 1)[0]; // (int) 0 
-[$beforeSingle] = $randomizer->pickArrayKeys(['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'], 1); // (string) foo+ // or: [$single] = $randomizer->pickArrayKeys($array, 1); 
 +$multiple = $randomizer->pickArrayKeys($array, 2); // (array) [1, 2]
 </code> </code>
  
 ==== "string" means a binary ==== ==== "string" means a binary ====
  
-In PHP, "string" means a binary. This is often a problem when using multibyte characters. For example, str_shuffle on a Japanese (UTF-8) string will give messed up results.+In PHP, "string" means a binary. This is often a problem when using multibyte characters. For example, <php>str_shuffle()</php> on a Japanese (UTF-8) string will give messed up results.
  
-Therefore, it may be better to change the alternative method of str_shuffle(), Randomizer::shuffleString(), to Randomizer::shuffleBytes(). This is a more appropriate name.+Therefore, it may be better to change the alternative method of str_shuffle(), ''Randomizer::shuffle**String**()'', to ''Randomizer::shuffle**Bytes**()''. This is a more appropriate name.
  
-==== Refine classnames ====+==== Engine classnames are not precise ====
  
-To make it more readable and regular, the class name is changed as follows:+To clearly identify the implemented algorithm, the PCG64 and MersenneTwister engines should be renamed to their canonical upstream name:
  
-  * Random\Engine\PCG64 -> Random\Engine\PcgOneseq128XslRr64 +  * ''Random\Engine\**PCG64**'' → ''Random\Engine\**PcgOneseq128XslRr64**'' 
-  * Random\Engine\MersenneTwister -> Random\Engine\Mt19937+  * ''Random\Engine\**MersenneTwister**'' → ''Random\Engine\**Mt19937**''
  
 ==== PCG is not so famous ==== ==== PCG is not so famous ====
  
 PCG is a very good algorithm, boasting great randomness and performance. PCG is a very good algorithm, boasting great randomness and performance.
- 
 However, I think its name recognition is in some ways inferior to Vigna's RNG, which started with Xorshift. However, I think its name recognition is in some ways inferior to Vigna's RNG, which started with Xorshift.
  
-Therefore, I reimplement Xoshiro256**, which was previously mentioned as a candidate, and create the class Random\Engine\Xoshiro256StarStar. This will avoid the problem of using the old MT19937 since it is not familiar with PCG.+Therefore, I reimplement %%Xoshiro256**%%, which was previously mentioned as a candidate, and create the class ''Random\Engine\Xoshiro256StarStar''. This will avoid the problem of using the old MT19937 since it is not familiar with PCG.
  
 ===== Proposal ===== ===== Proposal =====
Line 83: Line 87:
 ==== Engine implementations are not final ==== ==== Engine implementations are not final ====
  
-<doodle title="Engine implementations to final" auth="zeriyoshi" voteType="single" closed="true">+<doodle title="Make all implemented engines final?" auth="zeriyoshi" voteType="single" closed="true">
    * Yes    * Yes
    * No    * No
 </doodle> </doodle>
  
-==== Random\SerializableEngine is outdated ====+==== Random\SerializableEngine is not useful ====
  
-<doodle title="Remove Random\SerializableEngine" auth="zeriyoshi" voteType="single" closed="true">+<doodle title="Remove the SerializableEngine interface?" auth="zeriyoshi" voteType="single" closed="true">
    * Yes    * Yes
    * No    * No
 </doodle> </doodle>
  
-==== CombinedLCG is outdated ====+==== Random\Engine\CombinedLCG is low quality ====
  
-<doodle title="Drop Random\Engine\CombinedLCG" auth="zeriyoshi" voteType="single" closed="true">+<doodle title="Remove the CombinedLCG class?" auth="zeriyoshi" voteType="single" closed="true">
    * Yes    * Yes
    * No    * No
 </doodle> </doodle>
  
-==== Add Randomizer::pickArrayKeys(array $array, int $num): array method ====+==== There is no equivalent of array_rand() ====
  
-<doodle title="Add Random\Randomizer::pickArrayKeys(array $array, int $num): array" auth="zeriyoshi" voteType="single" closed="true">+<doodle title="Add the pickArrayKeys() method to the Randomizer?" auth="zeriyoshi" voteType="single" closed="true">
    * Yes    * Yes
    * No    * No
Line 111: Line 115:
 ==== "string" means a binary ==== ==== "string" means a binary ====
  
-<doodle title="Rename Random\Randomizer::shuffleString() to Random\Randomizer::shuffleBytes()" auth="zeriyoshi" voteType="single" closed="true">+<doodle title="Rename Randomizer::shuffleString() to Randomizer::shuffleBytes()?" auth="zeriyoshi" voteType="single" closed="true">
    * Yes    * Yes
    * No    * No
 </doodle> </doodle>
  
-==== Refine classnames ====+==== Engine classnames are not precise ====
  
-<doodle title="Change classnames" auth="zeriyoshi" voteType="single" closed="true">+<doodle title="Rename PCG64 and MersenneTwister?" auth="zeriyoshi" voteType="single" closed="true">
    * Yes    * Yes
    * No    * No
Line 125: Line 129:
 ==== PCG is not so famous ==== ==== PCG is not so famous ====
  
-<doodle title="Implement Random\Engine\Xoshiro256StarStar" auth="zeriyoshi" voteType="single" closed="true">+<doodle title="Add the Xoshiro256StarStar engine and class?" auth="zeriyoshi" voteType="single" closed="true">
    * Yes    * Yes
    * No    * No
Line 134: Line 138:
 The following names have been reserved and will no longer be available: The following names have been reserved and will no longer be available:
  
 +  * Random\Engine\Mt19937
   * Random\Engine\PcgOneseq128XslRr64   * Random\Engine\PcgOneseq128XslRr64
   * Random\Engine\Xoshiro256StarStar   * Random\Engine\Xoshiro256StarStar
-  * Random\Engine\Mt19937 
  
 The following class names will be made available again: The following class names will be made available again:
  
   * Random\Engine\CombinedLCG   * Random\Engine\CombinedLCG
 +  * Random\Engine\MersenneTwister
 +  * Random\Engine\PCG64
   * Random\SerializableEngine   * Random\SerializableEngine
  
Line 163: Line 169:
  
 ===== Patches and Tests ===== ===== Patches and Tests =====
-currently none+  * https://github.com/php/php-src/pull/8094
  
 ===== References ===== ===== References =====
  
   * https://externals.io/message/117939   * https://externals.io/message/117939
rfc/random_extension_improvement.1655907968.txt.gz · Last modified: 2022/06/22 14:26 by zeriyoshi

Page Tools