refactor!: remove MinimumLoad() option (#17)

## Description

The `cuckoo.MinimumLoad()` option was not a very useful option, and prone to error. By removing the ability to modify it, and setting it to something reasonable (like 5%), we can remove a whole set of errors that the user may stumble into.

## Changes

- Remove `MinimumLoad()` option.
- Privated `DefaultMinimumLoad`.

### Design Decisions

- `DefaultMinimumLoad` should be privated because it is no longer an option. The user should not need to interact with it.

## Checklist

- [x] Tests pass
- [x] Docs updated

Reviewed-on: #17

.gitea/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -7,20 +7,20 @@ body:
     id: context
     attributes:
       label: Context
-      description: What circumstances led to the bug?
+      placeholder: What circumstances led to the bug?
     validations:
       required: true
   - type: textarea
     id: expected-behavior
     attributes:
       label: Expected Behavior
-      description: What did you expect would happen?
+      placeholder: What did you expect would happen?
     validations:
       required: true
   - type: textarea
     id: actual-behavior
     attributes:
       label: Actual Behavior
-      description: What happened, and why was it unexpected?
+      placeholder: What happened, and why was it unexpected?
     validations:
       required: true

.gitea/ISSUE_TEMPLATE/FEATURE_REQUEST.yml

@@ -6,18 +6,10 @@ name: ✨ Feature Request
 about: Suggest an idea for this project
 title: "[FEATURE]: "
 body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this feature request! 🤗
-
-        Please make sure this feature request hasn't been already submitted by
-        someone by looking through other open/closed issues. 😃
   - type: dropdown
     attributes:
       multiple: false
-      label: Type of Feature
+      label: Feature Type
-      description: Select the type of feature request.
       options:
         - "✨ New Feature"
         - "📝 Documentation"
@@ -31,7 +23,7 @@ body:
     id: description
     attributes:
       label: Description
-      description: |
+      placeholder: |
         Give us a brief description of the feature or enhancement you would
         like!
     validations:
@@ -40,6 +32,6 @@ body:
     id: additional-information
     attributes:
       label: Additional Information
-      description: |
+      placeholder: |
         Give us some additional information on the feature request like proposed
         solutions, links, screenshots, etc.

.gitea/ISSUE_TEMPLATE/config.yml

@@ -1,2 +1,2 @@
 # yaml-language-server: $schema=https://www.schemastore.org/gitea-issue-config.json
-blank_issues_enabled: true
+blank_issues_enabled: false

.gitea/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+---
+name: "New Pull Request"
+about: "Standard PR template"
+title: ""
+ref: "main"
+---
+
+## Description
+
+## Changes
+
+### Design Decisions
+
+## Checklist
+
+- [ ] Tests pass
+- [ ] Docs updated

.gitea/workflows/ci.yml

@@ -9,10 +9,12 @@ jobs:
   check-pr-title:
     name: Check PR Title
     runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    env:
+      TITLE: ${{ gitea.event.pull_request.title }}
     steps:
       - run: |
-          TITLE="${{ gitea.event.pull_request.title }}"
+          if ! echo "$TITLE" | grep -qE '^(WIP: )?(feat|fix|docs|chore|ci|test|refactor|perf|build|style|revert)(\(.+\))?(!)?: .+'; then
-          if ! echo "$TITLE" | grep -qE '^(feat|fix|docs|chore|ci|test|refactor|perf|build|style|revert)(\(.+\))?(!)?: .+'; then
             echo "::error::Pull Request title must follow conventional commits"
             exit 1
           fi

cuckoo_fuzz_test.go

@@ -3,7 +3,6 @@ package cuckoo_test
 import (
 	"fmt"
 	"maps"
-	"math"
 	"os"
 	"testing"
 
@@ -30,7 +29,6 @@ type fuzzStep struct {
 type fuzzScenario struct {
 	seedA, seedB           uint32
 	capacity, growthFactor uint8
-	load                   float64
 	steps                  []fuzzStep
 }
 
@@ -48,7 +46,6 @@ func FuzzInsertLookup(f *testing.F) {
 		seedA, seedB := scenario.seedA, scenario.seedB
 		growthFactor := max(2, int(scenario.growthFactor))
 		capacity := int(scenario.capacity)
-		minimumLoad := math.Abs(math.Mod(scenario.load, 1.0))
 
 		// If they are the same number, the hashes will clash, always causing an
 		// error.
@@ -56,14 +53,8 @@ func FuzzInsertLookup(f *testing.F) {
 			t.Skip()
 		}
 
-		// If the load is too high, the hashs will not be able to allocate
+		fmt.Fprintf(os.Stderr, "seedA=%d seedB=%d capacity=%d growthFactor=%d\n",
-		// properly.
+			seedA, seedB, capacity, growthFactor)
-		if minimumLoad > 0.20 {
-			t.Skip()
-		}
-
-		fmt.Fprintf(os.Stderr, "seedA=%d seedB=%d capacity=%d growthFactor=%d minimumLoad=%f\n",
-			seedA, seedB, capacity, growthFactor, minimumLoad)
 
 		actual := cuckoo.NewCustomTable[uint32, uint32](
 			offsetHash(seedA),
@@ -71,7 +62,6 @@ func FuzzInsertLookup(f *testing.F) {
 			func(a, b uint32) bool { return a == b },
 			cuckoo.Capacity(capacity),
 			cuckoo.GrowthFactor(growthFactor),
-			cuckoo.MinimumLoad(minimumLoad),
 		)
 
 		expected := map[uint32]uint32{}

settings.go

@@ -12,11 +12,12 @@ const DefaultCapacity uint64 = 16
 // hash table implementations use 2.
 const DefaultGrowthFactor uint64 = 2
 
-// DefaultMinimumLoad is the default lowest acceptable occupancy of a [Table].
+// defaultMinimumLoad is the default lowest acceptable occupancy of a [Table].
-// The value of 5% is taken from [libcuckoo].
+// The higher the minimum load, the more likely that a [Table.Put] will not
+// succeed. The value of 5% is taken from [libcuckoo].
 //
 // [libcuckoo]: https://github.com/efficient/libcuckoo/blob/656714705a055df2b7a605eb3c71586d9da1e119/libcuckoo/cuckoohash_config.hh#L21
-const DefaultMinimumLoad float64 = 0.05
+const defaultMinimumLoad float64 = 0.05
 
 type settings struct {
 	growthFactor  uint64
@@ -38,19 +39,6 @@ func Capacity(value int) Option {
 	return func(s *settings) { s.bucketSize = uint64(value) }
 }
 
-// MinimumLoad modifies the [DefaultMinimumLoad] of the [Table]. The value must
-// be between 0.00 and 1.00.
-//
-// The higher the minimum load, the more likely that a [Table.Put] will not
-// succeed. Minimum loads above 20% are not tested.
-func MinimumLoad(value float64) Option {
-	if value < 0.00 || value > 1.00 {
-		panic(fmt.Sprintf("go-cuckoo: MinimumLoad must be between 0.00 and 1.00, got %f", value))
-	}
-
-	return func(s *settings) { s.minLoadFactor = value }
-}
-
 // GrowthFactor controls how much the capacity of the [Table] multiplies when
 // it must resize. The value must be greater than 1.
 func GrowthFactor(value int) Option {

table.go

@@ -198,7 +198,7 @@ func NewCustomTable[K, V any](hashA, hashB Hash[K], compare EqualFunc[K], option
 	settings := &settings{
 		growthFactor:  DefaultGrowthFactor,
 		bucketSize:    DefaultCapacity,
-		minLoadFactor: DefaultMinimumLoad,
+		minLoadFactor: defaultMinimumLoad,
 	}
 
 	for _, option := range options {