WeightedSelection 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
data/CHANGELOG ADDED
@@ -0,0 +1,6 @@
1
+ weightselect (1.0.0)
2
+
3
+ [ Blaine Cook ]
4
+ * initial import
5
+
6
+ -- Blaine Cook <romeda@gmail.com> Thu, 03 Aug 2006 03:09:42 -0800
data/COPYING ADDED
@@ -0,0 +1,281 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
data/README ADDED
@@ -0,0 +1,38 @@
1
+ = Name
2
+
3
+ WeightedSelection - Weighted Randomized Selections
4
+
5
+ = Synopsis
6
+
7
+ Implements a simple method for obtaining weighted randomized selections very
8
+ quickly. The selection object is simple to create, consumes very little
9
+ memory, and will return in the worst case in O(n) time, where n is the
10
+ number of possibilities.
11
+
12
+ = Description
13
+
14
+ See RDoc Documentation, available at weightedselect.rubyforge.org
15
+
16
+ = Known Issues
17
+
18
+ None - Please contribute bugs on RubyForge:
19
+ http://rubyforge.org/projects/weightedselect
20
+
21
+ = Copyright
22
+
23
+ WeightedSelection - Weighted Randomized Selection
24
+ Copyright 2006 Blaine Cook <romeda@gmail.com>.
25
+
26
+ WeightedSelection is free software; you can redistribute it and/or modify
27
+ it under the terms of the GNU General Public License as published by
28
+ the Free Software Foundation; either version 2 of the License, or
29
+ (at your option) any later version.
30
+
31
+ WeightedSelection is distributed in the hope that it will be useful,
32
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
33
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
34
+ GNU General Public License for more details.
35
+
36
+ You should have received a copy of the GNU General Public License
37
+ along with WeightedSelection; if not, write to the Free Software
38
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
data/Rakefile ADDED
@@ -0,0 +1,69 @@
1
+ # WeightedSelection - Weighted Randomized Selections
2
+ # Copyright 2006 Blaine Cook <romeda@gmail.com>.
3
+ #
4
+ # WeightedSelection is free software; you can redistribute it and/or modify
5
+ # it under the terms of the GNU General Public License as published by
6
+ # the Free Software Foundation; either version 2 of the License, or
7
+ # (at your option) any later version.
8
+ #
9
+ # WeightedSelection is distributed in the hope that it will be useful,
10
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
11
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
+ # GNU General Public License for more details.
13
+ #
14
+ # You should have received a copy of the GNU General Public License
15
+ # along with WeightedSelection; if not, write to the Free Software
16
+ # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17
+
18
+ require 'rubygems'
19
+ Gem::manage_gems
20
+ require 'rake/gempackagetask'
21
+ require 'rake/testtask'
22
+ require 'rake/rdoctask'
23
+ require 'rcov/rcovtask'
24
+
25
+ spec = Gem::Specification.new do |s|
26
+ s.name = "WeightedSelection"
27
+ s.version = "1.0.0"
28
+ s.author = "Blaine Cook"
29
+ s.email = "romeda@gmail.com"
30
+ s.homepage = "http://weightedselect.rubyforge.org/"
31
+ s.platform = Gem::Platform::RUBY
32
+ s.summary = "A simple library for obtaining weighted randomized selections"
33
+ s.files = FileList["{test,lib}/**/*", '[A-Z]*'].exclude("rdoc", ".svn").to_a
34
+ s.require_path = "lib"
35
+ s.autorequire = "weighted_selection"
36
+ s.test_files = Dir.glob("test/test_*.rb")
37
+ s.has_rdoc = true
38
+ s.extra_rdoc_files = ["README", "COPYING"]
39
+ s.rubyforge_project = "weightedselect"
40
+ end
41
+
42
+
43
+ Rake::GemPackageTask.new(spec) do |pkg|
44
+ pkg.gem_spec = spec
45
+ pkg.need_tar = true
46
+ pkg.need_zip = true
47
+ end
48
+
49
+ desc "Default Task"
50
+ task :default => [:tests]
51
+
52
+ desc "Run All Tests"
53
+ Rake::TestTask.new :tests do |test|
54
+ test.test_files = ["test/**/*.rb"]
55
+ test.verbose = true
56
+ end
57
+
58
+ desc "Generate Documentation"
59
+ Rake::RDocTask.new do |rdoc|
60
+ rdoc.main = "README"
61
+ rdoc.rdoc_dir = "doc"
62
+ rdoc.rdoc_files.include("README", "COPYING", "lib/*.rb")
63
+ rdoc.title = "WeightedSelection"
64
+ end
65
+
66
+ Rcov::RcovTask.new do |t|
67
+ t.test_files = FileList["test/**/test_*.rb"]
68
+ t.rcov_opts << "--sort coverage"
69
+ end
@@ -0,0 +1,144 @@
1
+ # Implements a simple method for obtaining weighted randomized selections very
2
+ # quickly. The selection object is simple to create, consumes very little
3
+ # memory, and will return in the worst case in O(n) time, where n is the
4
+ # number of possibilities.
5
+ #
6
+ # Basic usage is simply:
7
+ #
8
+ # selector = WeightedSelection.new( 'apple' => 1, 'orange' => 2, 'strawberry' => 7 )
9
+ # selector #=> 'apple', 'orange', or 'strawberry'
10
+ #
11
+ # In the above example, we expect 'apple' to be returned on average once out
12
+ # of every ten inspections of selector, 'orange' twice for every ten calls, and
13
+ # 'strawberry' seven times for every ten calls. Since this is a randomized
14
+ # selection, getting a very small selection may result in a pattern that doesn't
15
+ # match the specified cumulative weights. However, on large selections we expect
16
+ # relative result counts that will asymptotically approach the relative
17
+ # weightings.
18
+ #
19
+ # The formatting of the weighted selections is extremely flexible. The simplest
20
+ # form is expressed above, but it is worth noting that the weights are relative;
21
+ # x => 100, y => 200, z => 700 is exactly equivalent to x => 1, y => 2, z => 7
22
+ # in terms of generating a randomized selection.
23
+ #
24
+ # Another simple approach, if you'd prefer to avoid hashes, is to pass a nested
25
+ # array of 2-element arrays (or, specifically, anything that responds to to_a),
26
+ # like so:
27
+ #
28
+ # selector = WeightedSelection.new( [['a',1],['b',2]['c',3]] )
29
+ #
30
+ # For more complex situations where the selection weighting depends on context,
31
+ # you can pass a Proc as the weight, which will be evaluated each time a
32
+ # selection is made. For example:
33
+ #
34
+ # factor = 0
35
+ # weight = Proc.new { factor += 1; }
36
+ # selector = WeightedSelection.new( 'a' => weight, 'b' => 1 )
37
+ # selector #=> factor = 1, 1/2 'a', 1/2 'b'
38
+ # selector #=> factor = 2, 2/3 'a', 1/3 'b'
39
+ # selector #=> factor = 3, 3/4 'a', 1/4 'b'
40
+ # selector #=> factor = 4, 4/5 'a', 1/5 'b'
41
+ # selector #=> factor = 5, 5/6 'a', 1/6 'b'
42
+ #
43
+ # ... and so on.
44
+ #
45
+ # Additionally, the selection object supports a delegate object that should
46
+ # respond to a symbol provided as the weight, and return a Numeric weight for
47
+ # the selection. A very contrived example:
48
+ #
49
+ # class MyDelegate
50
+ # attr_accessor :x, :y, :z
51
+ # def initialize
52
+ # @x = 'rare'; @y = 'occasional'; @z = 'common'
53
+ # end
54
+ # def method_missing(methd)
55
+ # raise NameError unless methd.to_s.match('weight_for_(.)')
56
+ # freq = self.send($1) rescue nil
57
+ # case freq
58
+ # when 'rare': 0.1
59
+ # when 'occasional': 1
60
+ # when 'common': 10
61
+ # else 0
62
+ # end
63
+ # end
64
+ # end
65
+ #
66
+ # selector = WeightedSelection.new( 'x' => :weight_for_x, 'y' => :weight_for_y, 'z' => :weight_for_z )
67
+ # dlg = MyDelegate.new
68
+ # selector.delegate = dlg
69
+ # selector #=> 'x' < 1/100th of the time, 'y' < 1/10th of the time, 'z' < 9/10ths of the time
70
+ # dlg.x = 'common'
71
+ # dlg.y = 'rare'
72
+ # selector #=> 'x' < 1/2 of the time, 'y' < 1/500th of the time, 'z' < 1/2 of the time
73
+ #
74
+ # It's worth noting that the randomization is dependent on Ruby's rand() method,
75
+ # and additionally that WeightedSelection does *not* call srand() - if you want
76
+ # to ensure a truly random selection, or if you want to ensure a predictable
77
+ # selection order, you should call srand() before using WeightedSelection.
78
+ # Additionally, WeightedSelection in its current form is almost certainly not
79
+ # suitable for cryptographic use.
80
+
81
+ class WeightedSelection
82
+
83
+ attr_accessor :selections
84
+ attr_accessor :delegate
85
+
86
+ def initialize(options)
87
+ @selections = []
88
+ self << options
89
+ end
90
+
91
+ def <<(options)
92
+ raise TypeError, "expected name-weight pairs" unless options.respond_to?(:to_a)
93
+ selections = options.to_a.find_all { |opt| opt.respond_to?(:to_a) and opt.to_a.flatten.size == 2 }
94
+ @selections.concat( selections )
95
+ @modified = true
96
+ end
97
+
98
+ def keys
99
+ @selections.map { |x| x[0] }
100
+ end
101
+
102
+ def selection
103
+ evaluate_delegates
104
+ sort_selections
105
+
106
+ cumulative = 0.0
107
+ selected = nil
108
+
109
+ @selections.each do |entry|
110
+ payload, weighting = entry
111
+ cumulative += weighting
112
+ selected = payload if (rand * cumulative) < weighting
113
+ end
114
+
115
+ return selected
116
+ end
117
+
118
+ alias :inspect :selection
119
+
120
+ private
121
+
122
+ def evaluate_delegates
123
+ return unless @modified
124
+ @selections.map! { |sel| [ sel[0], find_value(sel[1], sel[0]) ] }
125
+ @modified = false
126
+ end
127
+
128
+ def find_value(val, option)
129
+ rv = case val
130
+ when Numeric: val
131
+ when Proc: val.call
132
+ when Symbol
133
+ @delegate.send(val, option) if @delegate and @delegate.respond_to? val
134
+ end
135
+
136
+ rv || 0
137
+ end
138
+
139
+ def sort_selections
140
+ @selections.sort! { |a,b| a[1] <=> b[1] } if @modified
141
+ @modified = false
142
+ end
143
+
144
+ end
@@ -0,0 +1,122 @@
1
+ require 'weighted_selection'
2
+ require 'test/unit'
3
+
4
+ class DelegateResponder
5
+ def initialize(options)
6
+ @options = options
7
+ end
8
+
9
+ def the_first(option)
10
+ factor = option == :third ? 1000 : 1
11
+ return @options[:the_first].size * factor rescue nil
12
+ end
13
+
14
+ def the_second(option)
15
+ return @options[:the_second].size rescue nil
16
+ end
17
+ end
18
+
19
+ class WeightedSelectionTest < Test::Unit::TestCase
20
+
21
+ def test_new_from_hash
22
+ weight = WeightedSelection.new( { :first => 1, :second => 2, :third => 3 } )
23
+ assert WeightedSelection, weight.class
24
+ end
25
+
26
+ def test_new_from_array
27
+ weight = WeightedSelection.new( [[:first, 1], [:second, 2], [:third, 3]] )
28
+ assert WeightedSelection, weight.class
29
+ end
30
+
31
+ def test_new_with_lambda
32
+ x = "fun"
33
+ y = "sun"
34
+ weight = WeightedSelection.new( { :first => lambda { x == "fun" ? 1 : 0 },
35
+ :second => lambda { y == "sunny" ? 1 : 0 } } )
36
+ 10.times { assert_equal :first, weight.selection }
37
+ end
38
+
39
+ def test_new_with_proc
40
+ x = "fun"
41
+ y = "sun"
42
+ weight = WeightedSelection.new( :first => Proc.new { x == "fun" ? 1 : 0 },
43
+ :second => Proc.new { y == "sunny" ? 1 : 0 } )
44
+ 10.times { assert_equal :first, weight.selection }
45
+ end
46
+
47
+ def test_new_with_delegate_symbol_values
48
+ weight = WeightedSelection.new( { :first => :the_first, :second => :the_second } )
49
+ weight.delegate = DelegateResponder.new( :the_first => "a very long string indeed!" * 1000, :the_second => "short" )
50
+ 10.times { assert_equal :first, weight.selection }
51
+ end
52
+
53
+ def test_new_with_delegate_sym_values_and_option
54
+ weight = WeightedSelection.new( { :first => :the_first, :second => :the_second, :third => :the_first } )
55
+ weight.delegate = DelegateResponder.new( :the_first => "a very long string indeed!" * 1000, :the_second => "short" )
56
+ 10.times { assert_equal :third, weight.selection }
57
+ end
58
+
59
+ def test_new_with_invalid_elements
60
+ weight = WeightedSelection.new( ["hello", 1234, [:first, 1]] )
61
+ 10.times { assert_equal :first, weight.selection }
62
+ end
63
+
64
+ def test_new_with_no_valid_elements
65
+ weight = WeightedSelection.new( ["one", 2, :three, [1,2,3]])
66
+ 10.times { assert_equal nil, weight.selection }
67
+ end
68
+
69
+ def test_weighted_outcome_with_percentages
70
+ weight = WeightedSelection.new( { :first => 0.25, :second => 0.15, :third => 0.60 } )
71
+
72
+ counts = get_counts(weight)
73
+
74
+ tfr = counts[:third] / counts[:first].to_f
75
+ tsr = counts[:third] / counts[:second].to_f
76
+ sfr = counts[:second] / counts[:first].to_f
77
+
78
+ assert tfr < 2.64 and tfr > 2.16
79
+ assert tsr < 4.40 and tsr > 3.60
80
+ assert sfr < 0.66 and sfr > 0.54
81
+ end
82
+
83
+ def test_weighted_outcome_with_integers
84
+ weight = WeightedSelection.new( { :first => 1, :second => 2, :third => 10 } )
85
+
86
+ counts = get_counts(weight)
87
+
88
+ tfr = counts[:third] / counts[:first].to_f
89
+ tsr = counts[:third] / counts[:second].to_f
90
+ sfr = counts[:second] / counts[:first].to_f
91
+
92
+ assert tfr < 11 and tfr > 9
93
+ assert tsr < 5.5 and tsr > 4.5
94
+ assert sfr < 2.2 and sfr > 1.8
95
+ end
96
+
97
+ private
98
+
99
+ def get_counts(weighter, iterations = 10000, attempts = 3)
100
+ zero_incr_counts = {}
101
+ weighter.keys.each { |x| zero_incr_counts[x] = 0 }
102
+
103
+ # Do the actual counts.
104
+ incr_counts = []
105
+ attempts.times do |i|
106
+ incr_counts[i] = zero_incr_counts.dup
107
+ iterations.times { incr_counts[i][ weighter.selection ] += 1 }
108
+ end
109
+
110
+ # Reduce attempt arrays to a single array.
111
+ counts = {}
112
+ attempts.times do |i|
113
+ incr_counts[i].each_pair do |selection,count|
114
+ counts[selection] ||= 0
115
+ counts[selection] += count
116
+ end
117
+ end
118
+ counts.keys.each { |x| counts[x] = counts[x]/attempts }
119
+
120
+ return counts
121
+ end
122
+ end
metadata ADDED
@@ -0,0 +1,52 @@
1
+ --- !ruby/object:Gem::Specification
2
+ rubygems_version: 0.8.11
3
+ specification_version: 1
4
+ name: WeightedSelection
5
+ version: !ruby/object:Gem::Version
6
+ version: 1.0.0
7
+ date: 2006-08-03 00:00:00 -07:00
8
+ summary: A simple library for obtaining weighted randomized selections
9
+ require_paths:
10
+ - lib
11
+ email: romeda@gmail.com
12
+ homepage: http://weightedselect.rubyforge.org/
13
+ rubyforge_project: weightedselect
14
+ description:
15
+ autorequire: weighted_selection
16
+ default_executable:
17
+ bindir: bin
18
+ has_rdoc: true
19
+ required_ruby_version: !ruby/object:Gem::Version::Requirement
20
+ requirements:
21
+ - - ">"
22
+ - !ruby/object:Gem::Version
23
+ version: 0.0.0
24
+ version:
25
+ platform: ruby
26
+ signing_key:
27
+ cert_chain:
28
+ authors:
29
+ - Blaine Cook
30
+ files:
31
+ - test/unit
32
+ - test/unit/test_selections.rb
33
+ - lib/weighted_selection.rb
34
+ - CHANGELOG
35
+ - COPYING
36
+ - Rakefile
37
+ - README
38
+ test_files: []
39
+
40
+ rdoc_options: []
41
+
42
+ extra_rdoc_files:
43
+ - README
44
+ - COPYING
45
+ executables: []
46
+
47
+ extensions: []
48
+
49
+ requirements: []
50
+
51
+ dependencies: []
52
+