File: weighted.go

package info (click to toggle)
golang-github-biogo-graph 0.0~git20150317.057c198-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid, trixie
  • size: 124 kB
  • sloc: makefile: 4
file content (79 lines) | stat: -rw-r--r-- 1,956 bytes parent folder | download | duplicates (2)
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Copyright ©2012 The bíogo Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package graph

import (
	"fmt"
	"math/rand"
)

// SelectorEmpty is returned when an attempt is made to select an item from a Selector with
// no remaining selectable items.
var SelectorEmpty = fmt.Errorf("graph: selector empty")

// A WeightedItem is a type that can be be selected from a population with a defined probability
// specified by the field Weight. Index is used as an index to the actual item in another slice.
type WeightedItem struct {
	Index         int
	Weight, total float64
}

// A Selector is a collection of weighted items that can be selected with weighted probabilities
// without replacement.
type Selector []WeightedItem

// Init must be called on a Selector before it is selected from. Init is idempotent.
func (s Selector) Init() {
	for i := range s {
		s[i].total = s[i].Weight
	}
	for i := len(s) - 1; i > 0; i-- {
		// sometimes 1-based counting makes sense
		s[(i+1)>>1-1].total += s[i].total
	}
}

// Select returns the value of the Index field of the chosen WeightedItem and the item is weighted
// zero to prevent further selection.
func (s Selector) Select() (int, error) {
	if s[0].total == 0 {
		return -1, SelectorEmpty
	}
	r, i := s[0].total*rand.Float64(), 1

	for {
		if r -= s[i-1].Weight; r <= 0 {
			break // fall within item i-1
		}
		i <<= 1 // move to left child
		if d := s[i-1].total; r > d {
			r -= d
			// if enough r to pass left child
			// move to right child
			// state will be caught at break above
			i++
		}
	}

	w, index := s[i-1].Weight, s[i-1].Index

	s[i-1].Weight = 0
	for i > 0 {
		s[i-1].total -= w
		i >>= 1
	}

	return index, nil
}

// Weight alters the weight of item i in the Selector.
func (s Selector) Weight(i int, w float64) {
	w, s[i].Weight = s[i].Weight-w, w
	i++
	for i > 0 {
		s[i-1].total -= w
		i >>= 1
	}
}