2025-11-03 15:37:45 +00:00
|
|
|
|
# Poindexter
|
|
|
|
|
|
|
|
|
|
|
|
Welcome to the Poindexter Go library documentation!
|
|
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
|
|
Poindexter is a Go library package licensed under EUPL-1.2.
|
|
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
|
|
- Simple and easy to use
|
|
|
|
|
|
- Comprehensive sorting utilities with custom comparators
|
|
|
|
|
|
- Generic sorting functions with type safety
|
|
|
|
|
|
- Binary search capabilities
|
|
|
|
|
|
- Well-documented API
|
|
|
|
|
|
- Comprehensive test coverage
|
|
|
|
|
|
- Cross-platform support
|
|
|
|
|
|
|
|
|
|
|
|
## Quick Start
|
|
|
|
|
|
|
|
|
|
|
|
Install the library:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
go get github.com/Snider/Poindexter
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
Use it in your code:
|
|
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
|
package main
|
|
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
|
"fmt"
|
|
|
|
|
|
"github.com/Snider/Poindexter"
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
func main() {
|
|
|
|
|
|
fmt.Println(poindexter.Hello("World"))
|
|
|
|
|
|
fmt.Println("Version:", poindexter.Version())
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
|
|
This project is licensed under the European Union Public Licence v1.2 (EUPL-1.2).
|
|
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
|
|
Contributions are welcome! Please feel free to submit a Pull Request.
|
2025-11-03 16:49:31 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
|
|
- Find the best (lowest‑ping) DHT peer using KDTree: [Best Ping Peer (DHT)](dht-best-ping.md)
|
2025-11-03 17:33:37 +00:00
|
|
|
|
- Multi-dimensional neighbor search over ping, hops, geo, and score: [Multi-Dimensional KDTree (DHT)](kdtree-multidimensional.md)
|
2025-11-03 18:26:40 +00:00
|
|
|
|
|
|
|
|
|
|
## Performance
|
|
|
|
|
|
|
|
|
|
|
|
- Benchmark methodology and guidance: [Performance](perf.md)
|
