autopilot/choice: return ErrNoPositive in case no choice can be made

This commit is contained in:
Johan T. Halseth 2018-12-10 11:23:19 +01:00
parent f1e8c8d5b5
commit 40db2dd5a5
No known key found for this signature in database
GPG Key ID: 15BAADA29DA20D26

@ -1,10 +1,15 @@
package autopilot
import (
"errors"
"fmt"
"math/rand"
)
// ErrNoPositive is returned from weightedChoice when there are no positive
// weights left to choose from.
var ErrNoPositive = errors.New("no positive weights left")
// weightedChoice draws a random index from the map of channel candidates, with
// a probability propotional to their score.
func weightedChoice(s map[NodeID]*AttachmentDirective) (NodeID, error) {
@ -15,7 +20,7 @@ func weightedChoice(s map[NodeID]*AttachmentDirective) (NodeID, error) {
}
if sum <= 0 {
return NodeID{}, fmt.Errorf("non-positive sum")
return NodeID{}, ErrNoPositive
}
// Create a map of normalized scores such, that they sum to 1.0.
@ -42,7 +47,7 @@ func weightedChoice(s map[NodeID]*AttachmentDirective) (NodeID, error) {
return k, nil
}
}
return NodeID{}, fmt.Errorf("no choice made")
return NodeID{}, fmt.Errorf("unable to make choice")
}
// chooseN picks at random min[n, len(s)] nodes if from the
@ -61,7 +66,9 @@ func chooseN(n int, s map[NodeID]*AttachmentDirective) (
chosen := make(map[NodeID]*AttachmentDirective)
for len(chosen) < n && len(rem) > 0 {
choice, err := weightedChoice(rem)
if err != nil {
if err == ErrNoPositive {
return chosen, nil
} else if err != nil {
return nil, err
}