diff options
| author | Stefan Majewsky <majewsky@gmx.net> | 2026-11-10 00:53:34 +0100 |
|---|---|---|
| committer | Stefan Majewsky <majewsky@gmx.net> | 2026-11-10 00:53:34 +0100 |
| commit | 5125060a1726c795219350c01ca23f1f99d9b08c (patch) | |
| tree | a74519621a7d73fd46f5175dd0072403841259d1 /runtimeindex.go | |
| parent | 1cc8b3d25658eb3ee320cb43265ddae289649786 (diff) | |
| download | go-oblast-5125060a1726c795219350c01ca23f1f99d9b08c.tar.gz | |
move RuntimeIndex
Diffstat (limited to 'runtimeindex.go')
| -rw-r--r-- | runtimeindex.go | 65 |
1 files changed, 0 insertions, 65 deletions
diff --git a/runtimeindex.go b/runtimeindex.go deleted file mode 100644 index 8167ba6..0000000 --- a/runtimeindex.go +++ /dev/null @@ -1,65 +0,0 @@ -// SPDX-FileCopyrightText: 2026 Stefan Majewsky <majewsky@gmx.net> -// SPDX-License-Identifier: Apache-2.0 - -package oblast - -// RuntimeIndex provides methods for sorting records (R) by some type of key (K) at runtime. -// It is most commonly used with the result of [Store.Select] or [Store.SelectWhere], to build a lookup table for or partition of the retrieved records. -type RuntimeIndex[R any, K comparable] func(R) K - -// TODO: rename Index() to Of(), IndexFrom() to From(), Partition() to PartitionOf() (in practice, instances of RuntimeIndex are often named e.g. ObjectByIDIndex, and then ObjectByIDIndex.IndexFrom() stutters) -> naming might need some workshopping -// TODO: make Index() and Partition() take an iter.Seq[], or alternatively add additional methods that do - -// NewRuntimeIndex casts a function into type [RuntimeIndex]. -// -// In practice, this is more compact than writing the cast directly -// because type arguments can be inferred for function calls, but not type casts. -func NewRuntimeIndex[R any, K comparable](f func(R) K) RuntimeIndex[R, K] { - return RuntimeIndex[R, K](f) -} - -// Index builds a lookup table of the provided records. -// -// This should only be used when the index yields unique values for each record. -// If there can be duplicates, use [RuntimeIndex.Partition] instead. -func (i RuntimeIndex[R, K]) Index(records []R) map[K]R { - result := make(map[K]R, len(records)) - for _, r := range records { - result[i(r)] = r - } - return result -} - -// IndexFrom is like Index, but can directly wrap a [Store.Select] or [Store.SelectWhere] call. -// If there is an error, it is passed through unchanged. -func (i RuntimeIndex[R, K]) IndexFrom(s Selection[R]) (map[K]R, error) { - result := make(map[K]R) - err := s.Foreach(func(record R) error { - result[i(record)] = record - return nil - }) - return result, err -} - -// Partition builds a partition of the resulting records by their index value. -// Within each partition, the original order of records is retained. -func (i RuntimeIndex[R, K]) Partition(records []R) map[K][]R { - result := make(map[K][]R, len(records)) - for _, r := range records { - key := i(r) - result[key] = append(result[key], r) - } - return result -} - -// PartitionFrom is like Partition, but can directly wrap a [Store.Select] or [Store.SelectWhere] call. -// If there is an error, it is passed through unchanged. -func (i RuntimeIndex[R, K]) PartitionFrom(s Selection[R]) (map[K][]R, error) { - result := make(map[K][]R) - err := s.Foreach(func(record R) error { - key := i(record) - result[key] = append(result[key], record) - return nil - }) - return result, err -} |
