Class: Beauvoir::Name

Inherits:
Object
  • Object
show all
Includes:
Statistics
Defined in:
lib/beauvoir/name.rb

Constant Summary

Constants included from Statistics

Statistics::MAGIC_STATISTICS_NUMBER

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Statistics

#estimated_female_value, #estimated_male_value, #estimated_value, #estimated_value_formula, #lower, #z

Constructor Details

#initialize(name, options = {}) ⇒ Name

Returns a new instance of Name.


7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/beauvoir/name.rb', line 7

def initialize(name, options={})
  # default_options = {
  #   :significance_level => 0.95,
  # }
  @options = options #default_options.merge(options)

  @male_count = 0
  @female_count = 0
  @name = name
  # @significance_level = @options[:significance_level]
end

Instance Attribute Details

#female_count ⇒ Object

Returns the value of attribute female_count.


5
6
7
 
# File 'lib/beauvoir/name.rb', line 5

def female_count
  @female_count
end

#male_count ⇒ Object

Returns the value of attribute male_count.


5
6
7
 
# File 'lib/beauvoir/name.rb', line 5

def male_count
  @male_count
end

#name ⇒ Object

Returns the value of attribute name.


5
6
7
 
# File 'lib/beauvoir/name.rb', line 5

def name
  @name
end

Instance Method Details

#guess_gender(threshold = DEFAULT_PROPORTION_THRESHOLD, lower_confidence_bound = DEFAULT_LOWER_CONFIDENCE_BOUND) ⇒ Object 


19
20
21
22
23
24
25
 
# File 'lib/beauvoir/name.rb', line 19

def guess_gender(threshold=DEFAULT_PROPORTION_THRESHOLD, lower_confidence_bound=DEFAULT_LOWER_CONFIDENCE_BOUND)
  if sufficiently_confident(threshold, lower_confidence_bound)
    gender
  else
    :unknown
  end
end

#raw_female_proportion ⇒ Object 


27
28
29
30
 
# File 'lib/beauvoir/name.rb', line 27

def raw_female_proportion
  return 0 unless self.total > 0
  @female_count / self.total
end

#raw_male_proportion ⇒ Object 


32
33
34
35
 
# File 'lib/beauvoir/name.rb', line 32

def raw_male_proportion
  return 0 unless self.total > 0
  @male_count / self.total
end

#total ⇒ Object 


37
38
39
 
# File 'lib/beauvoir/name.rb', line 37

def total
  (@male_count + @female_count).to_f
end