Class: Croupier::Distributions::Degenerate

Inherits:
Croupier::Distribution show all
Defined in:
lib/croupier/distributions/degenerate.rb

Overview

Degenerate Distribution Discrete probability distribution that returns the same value.

Instance Attribute Summary

Attributes inherited from Croupier::Distribution

#description, #name, #parameters

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Croupier::Distribution

#configure, #generate_sample, #params, #to_enum

Constructor Details

#initialize(options = {}) ⇒ Degenerate

Returns a new instance of Degenerate.



9
10
11
12
13
 
# File 'lib/croupier/distributions/degenerate.rb', line 9

def initialize(options={})
  @name = "Degenerate distribution"
  @description = "Discrete probability distribution that returns the same value each time."
  configure(options)
end

Class Method Details

.cli_name ⇒ Object 



23
24
25
 
# File 'lib/croupier/distributions/degenerate.rb', line 23

def self.cli_name
  "degenerate"
end

.cli_options ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/croupier/distributions/degenerate.rb', line 27

def self.cli_options
  {:options => [
     [:constant, 'value to be returned', {:type=>:float, :default => 42.0}]
   ],
   :banner => "Degenerate distribution. Discrete probability distribution that returns the same value each time."
  }
end

Instance Method Details

#default_parameters ⇒ Object 



19
20
21
 
# File 'lib/croupier/distributions/degenerate.rb', line 19

def default_parameters
  {:constant => 42.0}
end

#generate_number ⇒ Object 



15
16
17
 
# File 'lib/croupier/distributions/degenerate.rb', line 15

def generate_number
  params[:constant]
end