rbs 0.2.0

data/stdlib/prime/integer-extension.rbs

@@ -0,0 +1,23 @@
+extension Integer (Prime)
+  # Iterates the given block over all prime numbers.
+  #
+  # See Prime#each for more details.
+  #
+  def self.each_prime: (Integer) { (Integer) -> void } -> void
+
+  # Re-composes a prime factorization and returns the product.
+  #
+  # See Prime#int_from_prime_division for more details.
+  #
+  def self.from_prime_division: (Array[[ String ]]) -> Integer
+
+  # Returns the factorization of `self`.
+  #
+  # See Prime#prime_division for more details.
+  #
+  def prime_division: (?Prime::PseudoPrimeGenerator) -> Array[[ Integer, Integer ]]
+
+  # Returns true if `self` is a prime number, else returns false.
+  #
+  def prime?: () -> bool
+end

data/stdlib/prime/prime.rbs

@@ -0,0 +1,188 @@
+# The set of all prime numbers.
+#
+# ## Example
+#
+#     Prime.each(100) do |prime|
+#       p prime  #=> 2, 3, 5, 7, 11, ...., 97
+#     end
+#
+# Prime is Enumerable:
+#
+#     Prime.first 5 # => [2, 3, 5, 7, 11]
+#
+# ## Retrieving the instance
+#
+# For convenience, each instance method of `Prime`.instance can be accessed as a
+# class method of `Prime`.
+#
+# e.g.
+#     Prime.instance.prime?(2)  #=> true
+#     Prime.prime?(2)           #=> true
+#
+# ## Generators
+#
+# A "generator" provides an implementation of enumerating pseudo-prime numbers
+# and it remembers the position of enumeration and upper bound. Furthermore, it
+# is an external iterator of prime enumeration which is compatible with an
+# Enumerator.
+#
+# `Prime`::`PseudoPrimeGenerator` is the base class for generators. There are
+# few implementations of generator.
+#
+# `Prime`::`EratosthenesGenerator`
+# :   Uses eratosthenes' sieve.
+# `Prime`::`TrialDivisionGenerator`
+# :   Uses the trial division method.
+# `Prime`::`Generator23`
+# :   Generates all positive integers which are not divisible by either 2 or 3.
+#     This sequence is very bad as a pseudo-prime sequence. But this is faster
+#     and uses much less memory than the other generators. So, it is suitable
+#     for factorizing an integer which is not large but has many prime factors.
+#     e.g. for Prime#prime? .
+#
+#
+class Prime
+  # Iterates the given block over all prime numbers.
+  #
+  # ## Parameters
+  #
+  # `ubound`
+  # :   Optional. An arbitrary positive number. The upper bound of enumeration.
+  #     The method enumerates prime numbers infinitely if `ubound` is nil.
+  # `generator`
+  # :   Optional. An implementation of pseudo-prime generator.
+  #
+  #
+  # ## Return value
+  #
+  # An evaluated value of the given block at the last time. Or an enumerator which
+  # is compatible to an `Enumerator` if no block given.
+  #
+  # ## Description
+  #
+  # Calls `block` once for each prime number, passing the prime as a parameter.
+  #
+  # `ubound`
+  # :   Upper bound of prime numbers. The iterator stops after it yields all prime
+  #     numbers p <= `ubound`.
+  #
+  def self?.each: (?Integer? ubound, ?PseudoPrimeGenerator generator) { (Integer) -> void } -> void
+                | (?Integer? ubound, ?PseudoPrimeGenerator generator) -> PseudoPrimeGenerator
+
+  # Re-composes a prime factorization and returns the product.
+  #
+  # ## Parameters
+  # `pd`
+  # :   Array of pairs of integers. The each internal pair consists of a prime
+  #     number -- a prime factor -- and a natural number -- an exponent.
+  #
+  #
+  # ## Example
+  # For `[[p_1, e_1], [p_2, e_2], ...., [p_n, e_n]]`, it returns:
+  #
+  #     p_1**e_1 * p_2**e_2 * .... * p_n**e_n.
+  #
+  #     Prime.int_from_prime_division([[2,2], [3,1]])  #=> 12
+  #
+  def self?.int_from_prime_division: (Array[[ Integer, Integer ]]) -> Integer
+
+  # Returns true if `value` is a prime number, else returns false.
+  #
+  # ## Parameters
+  #
+  # `value`
+  # :   an arbitrary integer to be checked.
+  # `generator`
+  # :   optional. A pseudo-prime generator.
+  #
+  def self?.prime?: (Integer value, ?PseudoPrimeGenerator generator) -> bool
+
+  # Returns the factorization of `value`.
+  #
+  # ## Parameters
+  # `value`
+  # :   An arbitrary integer.
+  # `generator`
+  # :   Optional. A pseudo-prime generator. `generator`.succ must return the next
+  #     pseudo-prime number in the ascending order. It must generate all prime
+  #     numbers, but may also generate non prime numbers too.
+  #
+  #
+  # ### Exceptions
+  # `ZeroDivisionError`
+  # :   when `value` is zero.
+  #
+  #
+  # ## Example
+  # For an arbitrary integer:
+  #
+  #     n = p_1**e_1 * p_2**e_2 * .... * p_n**e_n,
+  #
+  # prime_division(n) returns:
+  #
+  #     [[p_1, e_1], [p_2, e_2], ...., [p_n, e_n]].
+  #
+  #     Prime.prime_division(12) #=> [[2,2], [3,1]]
+  #
+  def self?.prime_division: (Integer, ?PseudoPrimeGenerator generator) -> Array[[ Integer, Integer ]]
+
+  # Returns the singleton instance.
+  #
+  def self.instance: () -> Prime
+end
+
+# An abstract class for enumerating pseudo-prime numbers.
+#
+# Concrete subclasses should override succ, next, rewind.
+#
+class Prime::PseudoPrimeGenerator
+  def initialize: (?Integer?) -> void
+
+  include Enumerable[Integer, void]
+
+  attr_accessor upper_bound (): Integer?
+
+  # Iterates the given block for each prime number.
+  #
+  def each: () { (Integer) -> void } -> void
+
+  # alias of `succ`.
+  #
+  def next: () -> Integer
+
+  # Rewinds the internal position for enumeration.
+  #
+  # See `Enumerator`#rewind.
+  #
+  def rewind: () -> void
+
+  def size: () -> Float
+
+  # returns the next pseudo-prime number, and move the internal position forward.
+  #
+  # `PseudoPrimeGenerator`#succ raises `NotImplementedError`.
+  #
+  def succ: () -> Integer
+end
+
+# An implementation of `PseudoPrimeGenerator`.
+# 
+# Uses `EratosthenesSieve`.
+# 
+class Prime::EratosthenesGenerator < PseudoPrimeGenerator
+end
+
+# An implementation of `PseudoPrimeGenerator` which uses a prime table generated
+# by trial division.
+# 
+class Prime::TrialDivisionGenerator < PseudoPrimeGenerator
+end
+
+# Generates all integers which are greater than 2 and are not divisible by
+# either 2 or 3.
+# 
+# This is a pseudo-prime generator, suitable on checking primality of an integer
+# by brute force method.
+# 
+class Prime::Generator23 < PseudoPrimeGenerator
+end

data/stdlib/securerandom/securerandom.rbs

@@ -0,0 +1,9 @@
+module SecureRandom
+  def self.alphanumeric: (?Integer?) -> String
+  def self.base64: (?Integer?) -> String
+  def self.hex: (?Integer?) -> String
+  def self.random_bytes: (?Integer?) -> String
+  def self.random_number: (?Integer?) -> (Integer | Float)
+  def self.urlsafe_base64: (?Integer?, ?bool?) -> String
+  def self.uuid: () -> String
+end

data/stdlib/set/set.rbs

@@ -0,0 +1,301 @@
+# Set implements a collection of unordered values with no duplicates. This is a
+# hybrid of Array's intuitive inter-operation facilities and Hash's fast lookup.
+#
+# Set is easy to use with Enumerable objects (implementing `each`). Most of the
+# initializer methods and binary operators accept generic Enumerable objects
+# besides sets and arrays.  An Enumerable object can be converted to Set using
+# the `to_set` method.
+#
+# Set uses Hash as storage, so you must note the following points:
+#
+# *   Equality of elements is determined according to Object#eql? and
+#     Object#hash.  Use Set#compare_by_identity to make a set compare its
+#     elements by their identity.
+# *   Set assumes that the identity of each element does not change while it is
+#     stored.  Modifying an element of a set will render the set to an
+#     unreliable state.
+# *   When a string is to be stored, a frozen copy of the string is stored
+#     instead unless the original string is already frozen.
+#
+#
+# ## Comparison
+#
+# The comparison operators <, >, <=, and >= are implemented as shorthand for the
+# {proper_,}{subset?,superset?} methods.  However, the <=> operator is
+# intentionally left out because not every pair of sets is comparable ({x, y}
+# vs. {x, z} for example).
+#
+# ## Example
+#
+#     require 'set'
+#     s1 = Set[1, 2]                        #=> #<Set: {1, 2}>
+#     s2 = [1, 2].to_set                    #=> #<Set: {1, 2}>
+#     s1 == s2                              #=> true
+#     s1.add("foo")                         #=> #<Set: {1, 2, "foo"}>
+#     s1.merge([2, 6])                      #=> #<Set: {1, 2, "foo", 6}>
+#     s1.subset?(s2)                        #=> false
+#     s2.subset?(s1)                        #=> true
+#
+# ## Contact
+#
+#     - Akinori MUSHA <knu@iDaemons.org> (current maintainer)
+#
+class Set[A]
+  # Creates a new set containing the elements of the given enumerable object.
+  #
+  # If a block is given, the elements of enum are preprocessed by the given block.
+  #
+  #     Set.new([1, 2])                       #=> #<Set: {1, 2}>
+  #     Set.new([1, 2, 1])                    #=> #<Set: {1, 2}>
+  #     Set.new([1, 'c', :s])                 #=> #<Set: {1, "c", :s}>
+  #     Set.new(1..5)                         #=> #<Set: {1, 2, 3, 4, 5}>
+  #     Set.new([1, 2, 3]) { |x| x * x }      #=> #<Set: {1, 4, 9}>
+  #
+  def initialize: (_Each[A, untyped]) -> untyped
+                | [X] (_Each[X, untyped]) { (X) -> A } -> untyped
+                | (?nil) -> untyped
+
+  # Creates a new set containing the given objects.
+  #
+  #     Set[1, 2]                   # => #<Set: {1, 2}>
+  #     Set[1, 2, 1]                # => #<Set: {1, 2}>
+  #     Set[1, 'c', :s]             # => #<Set: {1, "c", :s}>
+  #
+  def self.[]: [X] (*X) -> Set[X]
+
+  # Returns a new set containing elements common to the set and the given
+  # enumerable object.
+  #
+  #     Set[1, 3, 5] & Set[3, 2, 1]             #=> #<Set: {3, 1}>
+  #     Set['a', 'b', 'z'] & ['a', 'b', 'c']    #=> #<Set: {"a", "b"}>
+  #
+  def &: (_Each[A, untyped]) -> self
+
+  alias intersection &
+
+  # Returns a new set built by merging the set and the elements of the given
+  # enumerable object.
+  #
+  #     Set[1, 2, 3] | Set[2, 4, 5]         #=> #<Set: {1, 2, 3, 4, 5}>
+  #     Set[1, 5, 'z'] | (1..6)             #=> #<Set: {1, 5, "z", 2, 3, 4, 6}>
+  #
+  def |: (_Each[A, untyped]) -> self
+
+  alias union |
+
+  alias + |
+
+  # Returns a new set built by duplicating the set, removing every element that
+  # appears in the given enumerable object.
+  #
+  #     Set[1, 3, 5] - Set[1, 5]                #=> #<Set: {3}>
+  #     Set['a', 'b', 'z'] - ['a', 'c']         #=> #<Set: {"b", "z"}>
+  #
+  def -: (_Each[A, untyped]) -> self
+
+  alias difference -
+
+  # Adds the given object to the set and returns self.  Use `merge` to add many
+  # elements at once.
+  #
+  #     Set[1, 2].add(3)                    #=> #<Set: {1, 2, 3}>
+  #     Set[1, 2].add([3, 4])               #=> #<Set: {1, 2, [3, 4]}>
+  #     Set[1, 2].add(2)                    #=> #<Set: {1, 2}>
+  #
+  def add: (A) -> self
+
+  alias << add
+
+  # Adds the given object to the set and returns self.  If the object is already
+  # in the set, returns nil.
+  #
+  #     Set[1, 2].add?(3)                    #=> #<Set: {1, 2, 3}>
+  #     Set[1, 2].add?([3, 4])               #=> #<Set: {1, 2, [3, 4]}>
+  #     Set[1, 2].add?(2)                    #=> nil
+  #
+  def add?: (A) -> self?
+
+  # Returns true if the set contains the given object.
+  #
+  # Note that `include?` and `member?` do not test member equality using `==` as
+  # do other Enumerables.
+  #
+  # See also Enumerable#include?
+  #
+  def include?: (untyped) -> bool
+
+  alias member? include?
+
+  # Returns a new set containing elements exclusive between the set and the given
+  # enumerable object.  (set ^ enum) is equivalent to ((set | enum) - (set &
+  # enum)).
+  #
+  #     Set[1, 2] ^ Set[2, 3]                   #=> #<Set: {3, 1}>
+  #     Set[1, 'b', 'c'] ^ ['b', 'd']           #=> #<Set: {"d", 1, "c"}>
+  #
+  def ^: (_Each[A, untyped]) -> self
+
+  # Classifies the set by the return value of the given block and returns a hash
+  # of {value => set of elements} pairs.  The block is called once for each
+  # element of the set, passing the element as parameter.
+  #
+  #     require 'set'
+  #     files = Set.new(Dir.glob("*.rb"))
+  #     hash = files.classify { |f| File.mtime(f).year }
+  #     hash       #=> {2000=>#<Set: {"a.rb", "b.rb"}>,
+  #                #    2001=>#<Set: {"c.rb", "d.rb", "e.rb"}>,
+  #                #    2002=>#<Set: {"f.rb"}>}
+  #
+  # Returns an enumerator if no block is given.
+  #
+  def classify: [X] () { (A) -> X } -> Hash[X, self]
+
+  # Removes all elements and returns self.
+  #
+  #     set = Set[1, 'c', :s]             #=> #<Set: {1, "c", :s}>
+  #     set.clear                         #=> #<Set: {}>
+  #     set                               #=> #<Set: {}>
+  #
+  def clear: () -> self
+
+  # Replaces the elements with ones returned by collect(). Returns an enumerator
+  # if no block is given.
+  #
+  def collect!: () { (A) -> A } -> self
+
+  alias map! collect!
+
+  # Deletes the given object from the set and returns self.  Use `subtract` to
+  # delete many items at once.
+  #
+  def delete: (untyped) -> self
+
+  # Deletes the given object from the set and returns self.  If the object is not
+  # in the set, returns nil.
+  #
+  def delete?: (untyped) -> self?
+
+  # Deletes every element of the set for which block evaluates to true, and
+  # returns self. Returns an enumerator if no block is given.
+  #
+  def delete_if: () { (A) -> untyped } -> self
+
+  # Equivalent to Set#delete_if, but returns nil if no changes were made. Returns
+  # an enumerator if no block is given.
+  #
+  def reject!: () { (A) -> untyped } -> self
+
+  # Returns true if the set and the given set have no element in common.  This
+  # method is the opposite of `intersect?`.
+  #
+  #     Set[1, 2, 3].disjoint? Set[3, 4]   #=> false
+  #     Set[1, 2, 3].disjoint? Set[4, 5]   #=> true
+  #
+  def disjoint?: (self) -> bool
+
+  # Divides the set into a set of subsets according to the commonality defined by
+  # the given block.
+  #
+  # If the arity of the block is 2, elements o1 and o2 are in common if
+  # block.call(o1, o2) is true.  Otherwise, elements o1 and o2 are in common if
+  # block.call(o1) == block.call(o2).
+  #
+  #     require 'set'
+  #     numbers = Set[1, 3, 4, 6, 9, 10, 11]
+  #     set = numbers.divide { |i,j| (i - j).abs == 1 }
+  #     set        #=> #<Set: {#<Set: {1}>,
+  #                #           #<Set: {11, 9, 10}>,
+  #                #           #<Set: {3, 4}>,
+  #                #           #<Set: {6}>}>
+  #
+  # Returns an enumerator if no block is given.
+  #
+  def divide: () { (A, A) -> untyped } -> Set[self]
+            | () { (A) -> untyped } -> Set[self]
+
+  # Calls the given block once for each element in the set, passing the element as
+  # parameter.  Returns an enumerator if no block is given.
+  #
+  def each: () { (A) -> void } -> self
+
+  # Returns true if the set contains no elements.
+  #
+  def empty?: () -> bool
+
+  # Returns a new set that is a copy of the set, flattening each containing set
+  # recursively.
+  #
+  def flatten: () -> Set[untyped]
+
+  # Returns true if the set and the given set have at least one element in common.
+  #
+  #     Set[1, 2, 3].intersect? Set[4, 5]   #=> false
+  #     Set[1, 2, 3].intersect? Set[3, 4]   #=> true
+  #
+  def intersect?: () -> bool
+
+  # Deletes every element of the set for which block evaluates to false, and
+  # returns self. Returns an enumerator if no block is given.
+  #
+  def keep_if: () { (A) -> untyped } -> self
+
+  # Returns the number of elements.
+  #
+  def size: () -> Integer
+
+  alias length size
+
+  # Merges the elements of the given enumerable object to the set and returns
+  # self.
+  #
+  def merge: (_Each[A, untyped]) -> self
+
+  # Returns true if the set is a subset of the given set.
+  #
+  def subset?: (self) -> bool
+
+  def proper_subst?: (self) -> bool
+
+  # Returns true if the set is a superset of the given set.
+  #
+  def superset?: (self) -> bool
+
+  # Returns true if the set is a proper superset of the given set.
+  #
+  def proper_superset?: (self) -> bool
+
+  # Replaces the contents of the set with the contents of the given enumerable
+  # object and returns self.
+  #
+  #     set = Set[1, 'c', :s]             #=> #<Set: {1, "c", :s}>
+  #     set.replace([1, 2])               #=> #<Set: {1, 2}>
+  #     set                               #=> #<Set: {1, 2}>
+  #
+  def replace: (_Each[A, untyped]) -> self
+
+  # Resets the internal state after modification to existing elements and returns
+  # self.
+  #
+  # Elements will be reindexed and deduplicated.
+  #
+  def reset: () -> self
+
+  # Equivalent to Set#keep_if, but returns nil if no changes were made. Returns an
+  # enumerator if no block is given.
+  #
+  def select!: () { (A) -> untyped } -> self?
+
+  # Deletes every element that appears in the given enumerable object and returns
+  # self.
+  #
+  def subtract: (_Each[A, untyped]) -> self
+
+  # Converts the set to an array.  The order of elements is uncertain.
+  #
+  #     Set[1, 2].to_a                    #=> [1, 2]
+  #     Set[1, 'c', :s].to_a              #=> [1, "c", :s]
+  #
+  def to_a: () -> Array[A]
+
+  include Enumerable[A, self]
+end