numo-random 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c6c4db2ffcb5672e571ad59dc94c36d51f87adb29007db4b9678b803840915
-  data.tar.gz: c1debe024fe523f28d97a83f7eaee51dc27cf51acfd1efa1cc44cd2994659c72
+  metadata.gz: 9c0f7c2bfe21c7c499f2d18453607b78ccd48bfea287336a3ce8ca4bee1a30e0
+  data.tar.gz: cef6d2005611cabe21606d3b9e3fe31b82ee9e34e909206c6b0b89b6fc78115d
 SHA512:
-  metadata.gz: 6364e78337ab7d87b0aa3cc18a2264992cb75ab15c65b0ce41065c78eacacbb96e21e55a5872a3878cb1ab143b4f8f7145ce4475e22eca725aef8a16fa0a8409
-  data.tar.gz: c3dfbd3d29761f951176395b2c48c596efbb998b3d1650484da908e576624557c60e8aabf64b015096aa0fb33780929c5a78b598a206ea659fdb4d75cea020f3
+  metadata.gz: 7e42a2ecae4e48173c0f96a8d5170bed05165c378289a3b84c1fdad56bd8dcc392b53596c1d3501ddf151bfdd6b10ae82032b6b6ca4f1f03a38e87e8ff83f418
+  data.tar.gz: 96f8de00675b3762ed859a5a9afef3fa8f2fe8a7d48562a3aae267d78caa963e9ddc6c514a6c14a0121b4ab1d633d370a04b6fd64551a60b46e03f73c94682b9

data/CHANGELOG.md

@@ -1,5 +1,5 @@
-## [Unreleased]
-- Bernoulli distribution.
+## [0.4.0]
+- Add method for random number generation with bernoulli distribution: bernoulli, binomial, negative_binomial, and geometric.
 
 ## [0.3.0]
 - Change native extension filename.

data/ext/numo/random/ext.hpp

@@ -58,6 +58,9 @@ public:
     rb_define_method(rb_cPCG64, "seed=", RUBY_METHOD_FUNC(_numo_random_pcg64_set_seed), 1);
     rb_define_method(rb_cPCG64, "seed", RUBY_METHOD_FUNC(_numo_random_pcg64_get_seed), 0);
     rb_define_method(rb_cPCG64, "random", RUBY_METHOD_FUNC(_numo_random_pcg64_random), 0);
+    rb_define_method(rb_cPCG64, "binomial", RUBY_METHOD_FUNC(_numo_random_pcg64_binomial), -1);
+    rb_define_method(rb_cPCG64, "negative_binomial", RUBY_METHOD_FUNC(_numo_random_pcg64_negative_binomial), -1);
+    rb_define_method(rb_cPCG64, "geometric", RUBY_METHOD_FUNC(_numo_random_pcg64_geometric), -1);
     rb_define_method(rb_cPCG64, "exponential", RUBY_METHOD_FUNC(_numo_random_pcg64_exponential), -1);
     rb_define_method(rb_cPCG64, "gamma", RUBY_METHOD_FUNC(_numo_random_pcg64_gamma), -1);
     rb_define_method(rb_cPCG64, "gumbel", RUBY_METHOD_FUNC(_numo_random_pcg64_gumbel), -1);
@@ -149,6 +152,157 @@ private:
     }
   }
 
+  // #binomial
+
+  template<typename T> static void _rand_binomial(VALUE& self, VALUE& x, const long n, const double& p) {
+    pcg64* ptr = get_pcg64(self);
+    ndfunc_arg_in_t ain[1] = { { OVERWRITE, 0 } };
+    std::binomial_distribution<T> binomial_dist(n, p);
+    ndfunc_t ndf = { _iter_rand<std::binomial_distribution<T>, T>, FULL_LOOP, 1, 0, ain, 0 };
+    rand_opt_t<std::binomial_distribution<T>> opt = { binomial_dist, ptr };
+    na_ndloop3(&ndf, &opt, 1, x);
+  }
+
+  static VALUE _numo_random_pcg64_binomial(int argc, VALUE* argv, VALUE self) {
+    VALUE x = Qnil;
+    VALUE kw_args = Qnil;
+    ID kw_table[2] = { rb_intern("n"), rb_intern("p") };
+    VALUE kw_values[2] = { Qundef, Qundef };
+    rb_scan_args(argc, argv, "1:", &x, &kw_args);
+    rb_get_kwargs(kw_args, kw_table, 2, 0, kw_values);
+
+    const VALUE klass = rb_obj_class(x);
+    if (klass != numo_cInt8 && klass != numo_cInt16 && klass != numo_cInt32 && klass != numo_cInt64
+        && klass != numo_cUInt8 && klass != numo_cUInt16 && klass != numo_cUInt32 && klass != numo_cUInt64)
+      rb_raise(rb_eTypeError, "invalid NArray class, it must be integer typed array");
+
+    const long n = NUM2LONG(kw_values[0]);
+    const double p = NUM2DBL(kw_values[1]);
+    if (n < 0) rb_raise(rb_eArgError, "n must be a non-negative value");
+    if (p < 0.0 || p > 1.0) rb_raise(rb_eArgError, "p must be >= 0 and <= 1");
+
+    if (klass == numo_cInt8) {
+      _rand_binomial<int8_t>(self, x, n, p);
+    } else if (klass == numo_cInt16) {
+      _rand_binomial<int16_t>(self, x, n, p);
+    } else if (klass == numo_cInt32) {
+      _rand_binomial<int32_t>(self, x, n, p);
+    } else if (klass == numo_cInt64) {
+      _rand_binomial<int64_t>(self, x, n, p);
+    } else if (klass == numo_cUInt8) {
+      _rand_binomial<uint8_t>(self, x, n, p);
+    } else if (klass == numo_cUInt16) {
+      _rand_binomial<uint16_t>(self, x, n, p);
+    } else if (klass == numo_cUInt32) {
+      _rand_binomial<uint32_t>(self, x, n, p);
+    } else if (klass == numo_cUInt64) {
+      _rand_binomial<uint64_t>(self, x, n, p);
+    }
+
+    RB_GC_GUARD(x);
+    return Qnil;
+  }
+
+  // #negative_binomial
+
+  template<typename T> static void _rand_negative_binomial(VALUE& self, VALUE& x, const long n, const double& p) {
+    pcg64* ptr = get_pcg64(self);
+    ndfunc_arg_in_t ain[1] = { { OVERWRITE, 0 } };
+    std::negative_binomial_distribution<T> negative_binomial_dist(n, p);
+    ndfunc_t ndf = { _iter_rand<std::negative_binomial_distribution<T>, T>, FULL_LOOP, 1, 0, ain, 0 };
+    rand_opt_t<std::negative_binomial_distribution<T>> opt = { negative_binomial_dist, ptr };
+    na_ndloop3(&ndf, &opt, 1, x);
+  }
+
+  static VALUE _numo_random_pcg64_negative_binomial(int argc, VALUE* argv, VALUE self) {
+    VALUE x = Qnil;
+    VALUE kw_args = Qnil;
+    ID kw_table[2] = { rb_intern("n"), rb_intern("p") };
+    VALUE kw_values[2] = { Qundef, Qundef };
+    rb_scan_args(argc, argv, "1:", &x, &kw_args);
+    rb_get_kwargs(kw_args, kw_table, 2, 0, kw_values);
+
+    const VALUE klass = rb_obj_class(x);
+    if (klass != numo_cInt8 && klass != numo_cInt16 && klass != numo_cInt32 && klass != numo_cInt64
+        && klass != numo_cUInt8 && klass != numo_cUInt16 && klass != numo_cUInt32 && klass != numo_cUInt64)
+      rb_raise(rb_eTypeError, "invalid NArray class, it must be integer typed array");
+
+    const long n = NUM2LONG(kw_values[0]);
+    const double p = NUM2DBL(kw_values[1]);
+    if (n < 0) rb_raise(rb_eArgError, "n must be a non-negative value");
+    if (p <= 0.0 || p > 1.0) rb_raise(rb_eArgError, "p must be > 0 and <= 1");
+
+    if (klass == numo_cInt8) {
+      _rand_negative_binomial<int8_t>(self, x, n, p);
+    } else if (klass == numo_cInt16) {
+      _rand_negative_binomial<int16_t>(self, x, n, p);
+    } else if (klass == numo_cInt32) {
+      _rand_negative_binomial<int32_t>(self, x, n, p);
+    } else if (klass == numo_cInt64) {
+      _rand_negative_binomial<int64_t>(self, x, n, p);
+    } else if (klass == numo_cUInt8) {
+      _rand_negative_binomial<uint8_t>(self, x, n, p);
+    } else if (klass == numo_cUInt16) {
+      _rand_negative_binomial<uint16_t>(self, x, n, p);
+    } else if (klass == numo_cUInt32) {
+      _rand_negative_binomial<uint32_t>(self, x, n, p);
+    } else if (klass == numo_cUInt64) {
+      _rand_negative_binomial<uint64_t>(self, x, n, p);
+    }
+
+    RB_GC_GUARD(x);
+    return Qnil;
+  }
+
+  // #geometric
+
+  template<typename T> static void _rand_geometric(VALUE& self, VALUE& x, const double& p) {
+    pcg64* ptr = get_pcg64(self);
+    ndfunc_arg_in_t ain[1] = { { OVERWRITE, 0 } };
+    std::geometric_distribution<T> geometric_dist(p);
+    ndfunc_t ndf = { _iter_rand<std::geometric_distribution<T>, T>, FULL_LOOP, 1, 0, ain, 0 };
+    rand_opt_t<std::geometric_distribution<T>> opt = { geometric_dist, ptr };
+    na_ndloop3(&ndf, &opt, 1, x);
+  }
+
+  static VALUE _numo_random_pcg64_geometric(int argc, VALUE* argv, VALUE self) {
+    VALUE x = Qnil;
+    VALUE kw_args = Qnil;
+    ID kw_table[1] = { rb_intern("p") };
+    VALUE kw_values[1] = { Qundef };
+    rb_scan_args(argc, argv, "1:", &x, &kw_args);
+    rb_get_kwargs(kw_args, kw_table, 1, 0, kw_values);
+
+    const VALUE klass = rb_obj_class(x);
+    if (klass != numo_cInt8 && klass != numo_cInt16 && klass != numo_cInt32 && klass != numo_cInt64
+        && klass != numo_cUInt8 && klass != numo_cUInt16 && klass != numo_cUInt32 && klass != numo_cUInt64)
+      rb_raise(rb_eTypeError, "invalid NArray class, it must be integer typed array");
+
+    const double p = NUM2DBL(kw_values[0]);
+    if (p <= 0.0 || p >= 1.0) rb_raise(rb_eArgError, "p must be > 0 and < 1");
+
+    if (klass == numo_cInt8) {
+      _rand_geometric<int8_t>(self, x,  p);
+    } else if (klass == numo_cInt16) {
+      _rand_geometric<int16_t>(self, x, p);
+    } else if (klass == numo_cInt32) {
+      _rand_geometric<int32_t>(self, x, p);
+    } else if (klass == numo_cInt64) {
+      _rand_geometric<int64_t>(self, x, p);
+    } else if (klass == numo_cUInt8) {
+      _rand_geometric<uint8_t>(self, x, p);
+    } else if (klass == numo_cUInt16) {
+      _rand_geometric<uint16_t>(self, x, p);
+    } else if (klass == numo_cUInt32) {
+      _rand_geometric<uint32_t>(self, x, p);
+    } else if (klass == numo_cUInt64) {
+      _rand_geometric<uint64_t>(self, x, p);
+    }
+
+    RB_GC_GUARD(x);
+    return Qnil;
+  }
+
   // #exponential
 
   template<typename T> static void _rand_exponential(VALUE& self, VALUE& x, const double& lam) {
@@ -272,8 +426,8 @@ private:
   static VALUE _numo_random_pcg64_poisson(int argc, VALUE* argv, VALUE self) {
     VALUE x = Qnil;
     VALUE kw_args = Qnil;
-    ID kw_table[2] = { rb_intern("mean") };
-    VALUE kw_values[2] = { Qundef, Qundef };
+    ID kw_table[1] = { rb_intern("mean") };
+    VALUE kw_values[1] = { Qundef };
     rb_scan_args(argc, argv, "1:", &x, &kw_args);
     rb_get_kwargs(kw_args, kw_table, 0, 1, kw_values);
 

data/lib/numo/random/generator.rb

@@ -57,6 +57,78 @@ module Numo
         rng.random
       end
 
+      # Generates array consists of random values according to the Bernoulli distribution.
+      #
+      # @example
+      #   require 'numo/random'
+      #
+      #   rng = Numo::Random::Generator.new(seed: 42)
+      #   x = rng.bernoulli(shape: 1000, p: 0.4)
+      #
+      # @param shape [Integer | Array<Integer>] size of random array.
+      # @param p [Float] probability of success.
+      # @param dtype [Symbol] data type of random array.
+      # @return [Numo::IntX | Numo::UIntX]
+      def bernoulli(shape:, p:, dtype: :int32)
+        binomial(shape: shape, n: 1, p: p, dtype: dtype)
+      end
+
+      # Generates array consists of random values according to a binomial distribution.
+      #
+      # @example
+      #   require 'numo/random'
+      #
+      #   rng = Numo::Random::Generator.new(seed: 42)
+      #   x = rng.binomial(shape: 1000, n: 10, p: 0.4)
+      #
+      # @param shape [Integer | Array<Integer>] size of random array.
+      # @param n [Integer] number of trials.
+      # @param p [Float] probability of success.
+      # @param dtype [Symbol] data type of random array.
+      # @return [Numo::IntX | Numo::UIntX]
+      def binomial(shape:, n:, p:, dtype: :int32)
+        x = klass(dtype).new(shape)
+        rng.binomial(x, n: n, p: p)
+        x
+      end
+
+      # Generates array consists of random values according to a negative binomial distribution.
+      #
+      # @example
+      #   require 'numo/random'
+      #
+      #   rng = Numo::Random::Generator.new(seed: 42)
+      #   x = rng.negative_binomial(shape: 1000, n: 10, p: 0.4)
+      #
+      # @param shape [Integer | Array<Integer>] size of random array.
+      # @param n [Integer] number of trials.
+      # @param p [Float] probability of success.
+      # @param dtype [Symbol] data type of random array.
+      # @return [Numo::IntX | Numo::UIntX]
+      def negative_binomial(shape:, n:, p:, dtype: :int32)
+        x = klass(dtype).new(shape)
+        rng.negative_binomial(x, n: n, p: p)
+        x
+      end
+
+      # Generates array consists of random values according to a geometric distribution.
+      #
+      # @example
+      #   require 'numo/random'
+      #
+      #   rng = Numo::Random::Generator.new(seed: 42)
+      #   x = rng.geometric(shape: 1000, p: 0.4)
+      #
+      # @param shape [Integer | Array<Integer>] size of random array.
+      # @param p [Float] probability of success on each trial.
+      # @param dtype [Symbol] data type of random array.
+      # @return [Numo::IntX | Numo::UIntX]
+      def geometric(shape:, p:, dtype: :int32)
+        x = klass(dtype).new(shape)
+        rng.geometric(x, p: p)
+        x
+      end
+
       # Generates array consists of random values with an exponential distribution.
       #
       # @example

data/lib/numo/random/version.rb

@@ -3,6 +3,6 @@
 module Numo
   module Random
     # The version of Numo::Random you install.
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-random
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray