6 Commits

Author SHA1 Message Date
0bdf71fd12 refactor: 'MinimumLoad' to 'defaultMinimumLoad'
Some checks failed
CI / Check PR Title (pull_request) Failing after 18s
CI / Go Lint (pull_request) Successful in 36s
CI / Markdown Lint (pull_request) Successful in 22s
CI / Makefile Lint (pull_request) Successful in 34s
CI / Unit Tests (pull_request) Successful in 36s
CI / Fuzz Tests (pull_request) Successful in 1m6s
CI / Mutation Tests (pull_request) Successful in 1m1s
- The option does not need to be exported, since it is no longer an
  option.
2026-04-03 16:26:51 +02:00
8b55ce7264 feat: remove minimum-load option, hard-coded to 5% 2026-04-03 16:24:25 +02:00
c834f004a2 chore: no free form issues, 'description'-s to 'placeholders'-s (#16)
Some checks failed
CI / Check PR Title (push) Failing after 19s
CI / Makefile Lint (push) Successful in 34s
CI / Go Lint (push) Successful in 37s
CI / Markdown Lint (push) Successful in 35s
CI / Unit Tests (push) Successful in 33s
CI / Fuzz Tests (push) Successful in 1m4s
CI / Mutation Tests (push) Successful in 2m55s
## Description

There were some problems with the roll-out of the issue templates. This PR addresses them.

## Changes

- Disable `blank-issue-enabled`.
- Move all `description` types in the issue templates to `placeholder`.

### Design Decisions

- The `description` fields take up too much space.

## Checklist

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

Reviewed-on: #16
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-04-03 13:57:03 +00:00
581f26f562 ci: support semantic versioning, conventional commits (#15)
Some checks failed
CI / Check PR Title (push) Failing after 18s
CI / Makefile Lint (push) Successful in 33s
CI / Markdown Lint (push) Successful in 22s
CI / Unit Tests (push) Successful in 30s
CI / Go Lint (push) Successful in 45s
CI / Mutation Tests (push) Successful in 1m18s
CI / Fuzz Tests (push) Successful in 1m48s
## Description

Currently, the repository is not well suited for semantic versioning, and hasn't much to support it. This PR adds templates, CI jobs, and configs to simplify its adoption.

## Changes

- Added `FEATURE` and `BUG` issue templates. Also, forbids free-form issues.
- Adds a PR template.
- Adds a CI job to ensure the commit title follows conventional commits.

### Design Decisions

N/A.

## Checklist

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

Reviewed-on: #15
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-04-03 13:46:05 +00:00
b1ab3a6326 chore: remove ./.claude/settings.json (#14)
All checks were successful
CI / Go Lint (push) Successful in 29s
CI / Makefile Lint (push) Successful in 28s
CI / Markdown Lint (push) Successful in 16s
CI / Unit Tests (push) Successful in 28s
CI / Fuzz Tests (push) Successful in 59s
CI / Mutation Tests (push) Successful in 1m7s
There shouldn't be a global settings folder for Claude in the repository. Also, add final newline to `.gitignore`.

Reviewed-on: #14
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-28 19:52:06 +00:00
36d76d4929 feat: wider fuzz tests, stronger options. (#9)
All checks were successful
CI / Go Lint (push) Successful in 38s
CI / Markdown Lint (push) Successful in 12s
CI / Makefile Lint (push) Successful in 30s
CI / Unit Tests (push) Successful in 28s
CI / Fuzz Tests (push) Successful in 1m1s
CI / Mutation Tests (push) Successful in 57s
- Added all `Option`-s to the fuzz tests.
  - Minimum load is always <=20%.
- Tested all options, and force a panic on all invalid options.
  - Capacity must now be non-negative.
  - Minimum load should be <=20%, but just put it as a recommendation.

Reviewed-on: #9
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-25 01:26:56 +00:00
13 changed files with 125 additions and 139 deletions

View File

@@ -1,7 +0,0 @@
{
"permissions": {
"allow": [
"Bash(curl -s -w \"\\\\n---HTTP_STATUS:%{http_code}---\" https://raw.githubusercontent.com/kubernetes/kubernetes/master/.markdownlint.yaml)"
]
}
}

View File

@@ -1,71 +0,0 @@
name: Bug Report
about: File a bug report
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
# some markdown that will only be visible once the issue has been created
- type: markdown
attributes:
value: |
This issue was created by an issue **template** :)
visible: [content]
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of our software are you running?
options:
- 1.0.2 (Default)
- 1.0.3 (Edge)
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
hide_label: true
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- label: I have also read the CONTRIBUTION.MD
required: true
visible: [form]
- label: This is a TODO only visible after issue creation
visible: [content]

View File

@@ -0,0 +1,26 @@
# yaml-language-server: $schema=https://www.schemastore.org/gitea-issue-forms.json
name: 🐛 Bug Report
about: Report a bug in this project
title: "[BUG]: "
body:
- type: textarea
id: context
attributes:
label: Context
placeholder: What circumstances led to the bug?
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
placeholder: What did you expect would happen?
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
placeholder: What happened, and why was it unexpected?
validations:
required: true

View File

@@ -0,0 +1,37 @@
# 'Feature Request Template' By @cheehwatang
# https://github.com/cheehwatang/.github/blob/master/.github/ISSUE_TEMPLATE/feature_request.yml
#
# yaml-language-server: $schema=https://www.schemastore.org/gitea-issue-forms.json
name: ✨ Feature Request
about: Suggest an idea for this project
title: "[FEATURE]: "
body:
- type: dropdown
attributes:
multiple: false
label: Feature Type
options:
- "✨ New Feature"
- "📝 Documentation"
- "🎨 Style and UI"
- "🔨 Code Refactor"
- "⚡ Performance Improvements"
- "✅ New Test"
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
placeholder: |
Give us a brief description of the feature or enhancement you would
like!
validations:
required: true
- type: textarea
id: additional-information
attributes:
label: Additional Information
placeholder: |
Give us some additional information on the feature request like proposed
solutions, links, screenshots, etc.

View File

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

View File

@@ -1,12 +1,17 @@
--- ---
name: "Pull Request Template" name: "New Pull Request"
about: "This template is for general pull requests!" about: "Standard PR template"
title: "<type>[optional scope]: <description>" title: ""
ref: "main" ref: "main"
assignees: ["user1"]
labels:
- bug
- "help needed"
--- ---
This is the template! ## Description
## Changes
### Design Decisions
## Checklist
- [ ] Tests pass
- [ ] Docs updated

View File

@@ -6,6 +6,17 @@ on:
pull_request: pull_request:
jobs: jobs:
check-pr-title:
name: Check PR Title
runs-on: ubuntu-latest
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
echo "::error::Pull Request title must follow conventional commits"
exit 1
fi
lint-go: lint-go:
name: Go Lint name: Go Lint
runs-on: ubuntu-latest runs-on: ubuntu-latest

View File

@@ -1,22 +0,0 @@
name: Release
on:
push:
branches: [main]
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- run: pip install python-semantic-release
- run: semantic-release version --push --vcs-release
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}

1
.gitignore vendored
View File

@@ -24,4 +24,3 @@ go.work.sum
# env file # env file
.env .env

View File

@@ -1,7 +1,9 @@
package cuckoo_test package cuckoo_test
import ( import (
"fmt"
"maps" "maps"
"os"
"testing" "testing"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
@@ -25,8 +27,9 @@ type fuzzStep struct {
} }
type fuzzScenario struct { type fuzzScenario struct {
seedA, seedB uint32 seedA, seedB uint32
steps []fuzzStep capacity, growthFactor uint8
steps []fuzzStep
} }
func FuzzInsertLookup(f *testing.F) { func FuzzInsertLookup(f *testing.F) {
@@ -40,14 +43,25 @@ func FuzzInsertLookup(f *testing.F) {
return return
} }
if scenario.seedA == scenario.seedB { seedA, seedB := scenario.seedA, scenario.seedB
return growthFactor := max(2, int(scenario.growthFactor))
capacity := int(scenario.capacity)
// If they are the same number, the hashes will clash, always causing an
// error.
if seedA == seedB {
t.Skip()
} }
fmt.Fprintf(os.Stderr, "seedA=%d seedB=%d capacity=%d growthFactor=%d\n",
seedA, seedB, capacity, growthFactor)
actual := cuckoo.NewCustomTable[uint32, uint32]( actual := cuckoo.NewCustomTable[uint32, uint32](
offsetHash(scenario.seedA), offsetHash(seedA),
offsetHash(scenario.seedB), offsetHash(seedB),
func(a, b uint32) bool { return a == b }, func(a, b uint32) bool { return a == b },
cuckoo.Capacity(capacity),
cuckoo.GrowthFactor(growthFactor),
) )
expected := map[uint32]uint32{} expected := map[uint32]uint32{}

View File

@@ -1,13 +0,0 @@
#:schema https://json.schemastore.org/pyproject.json
[tool.semantic_release]
commit_parser = "angular"
version_toml = []
tag_format = "v{version}"
[tool.semantic_release.remote]
type = "gitea"
domain = "git.maximhutz.com"
[tool.semantic_release.remote.token]
env = "GITEA_TOKEN"

View File

@@ -1,5 +1,7 @@
package cuckoo package cuckoo
import "fmt"
// DefaultCapacity is the initial capacity of a [Table]. It is inspired from // DefaultCapacity is the initial capacity of a [Table]. It is inspired from
// Java's [HashMap] implementation, which also uses 16. // Java's [HashMap] implementation, which also uses 16.
// //
@@ -10,11 +12,12 @@ const DefaultCapacity uint64 = 16
// hash table implementations use 2. // hash table implementations use 2.
const DefaultGrowthFactor uint64 = 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 // [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 { type settings struct {
growthFactor uint64 growthFactor uint64
@@ -27,19 +30,21 @@ type settings struct {
type Option func(*settings) type Option func(*settings)
// Capacity modifies the starting capacity of each bucket of the [Table]. The // Capacity modifies the starting capacity of each bucket of the [Table]. The
// value must be greater than 0. // value must be non-negative.
func Capacity(value int) Option { func Capacity(value int) Option {
return func(s *settings) { s.bucketSize = uint64(value) } if value < 0 {
} panic(fmt.Sprintf("go-cuckoo: Capacity must be non-negative, got %d", value))
}
// MinimumLoad modifies the [DefaultMinimumLoad] of the [Table]. The value must return func(s *settings) { s.bucketSize = uint64(value) }
// be between 0.00 and 1.00.
func MinimumLoad(value float64) Option {
return func(s *settings) { s.minLoadFactor = value }
} }
// GrowthFactor controls how much the capacity of the [Table] multiplies when // GrowthFactor controls how much the capacity of the [Table] multiplies when
// it must resize. The value must be greater than 1. // it must resize. The value must be greater than 1.
func GrowthFactor(value int) Option { func GrowthFactor(value int) Option {
if value < 2 {
panic(fmt.Sprintf("go-cuckoo: GrowthFactor must be greater than 1, got %d", value))
}
return func(s *settings) { s.growthFactor = uint64(value) } return func(s *settings) { s.growthFactor = uint64(value) }
} }

View File

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