hash.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

class Hash
  # call-seq:
  #   Hash.new(default_value = nil, capacity: 0) -> new_hash
  #   Hash.new(capacity: 0) {|self, key| ... } -> new_hash
  #
  # Returns a new empty \Hash object.
  # Initializes the values of Hash#default and Hash#default_proc,
  # which determine the value to be returned by method Hash#[] when the entry does not exist.
  #
  # By default, a hash has +nil+ values for both +default+ and +default_proc+:
  #
  #   h = Hash.new        # => {}
  #   h.default           # => nil
  #   h.default_proc      # => nil
  #
  # If the +default_value+ argument is provided, it sets the +default+ value for the hash:
  #
  #   h = Hash.new(false) # => {}
  #   h.default           # => false
  #   h.default_proc      # => nil
  #
  # If a block is given, it sets the +default_proc+ value:
  #
  #   h = Hash.new {|hash, key| "Hash #{hash}: Default value for #{key}" }
  #   h.default      # => nil
  #   h.default_proc # => #<Proc:0x00000289b6fa7048 (irb):185>
  #   h[:nosuch]     # => "Hash {}: Default value for nosuch"
  #
  # If optional keyword argument +capacity+ is given with a positive integer value +n+,
  # initializes the hash with enough capacity to accommodate +n+ entries without resizing.
  #
  # See also {Methods for Creating a Hash}[rdoc-ref:Hash@Methods+for+Creating+a+Hash].
  def initialize(ifnone = (ifnone_unset = true), capacity: 0, &block)
    Primitive.rb_hash_init(capacity, ifnone_unset, ifnone, block)
  end
end