File: orderedintset.go

package info (click to toggle)
hugo 0.154.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 49,556 kB
  • sloc: javascript: 31,879; ansic: 2,328; xml: 350; makefile: 197; sh: 50; asm: 48
file content (154 lines) | stat: -rw-r--r-- 3,560 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// Copyright 2025 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package maps

import (
	"fmt"
	"slices"

	"github.com/bits-and-blooms/bitset"
)

type OrderedIntSet struct {
	keys   []int
	values *bitset.BitSet
}

// NewOrderedIntSet creates a new OrderedIntSet.
// Note that this is backed by https://github.com/bits-and-blooms/bitset
func NewOrderedIntSet(vals ...int) *OrderedIntSet {
	m := &OrderedIntSet{
		keys:   make([]int, 0, len(vals)),
		values: bitset.New(uint(len(vals))),
	}
	for _, v := range vals {
		m.Set(v)
	}
	return m
}

// Set sets the value for the given key.
// Note that insertion order is not affected if a key is re-inserted into the set.
func (m *OrderedIntSet) Set(key int) {
	if m == nil {
		panic("nil OrderedIntSet")
	}
	keyu := uint(key)
	if m.values.Test(keyu) {
		return
	}
	m.values.Set(keyu)
	m.keys = append(m.keys, key)
}

// SetFrom sets the values from another OrderedIntSet.
func (m *OrderedIntSet) SetFrom(other *OrderedIntSet) {
	if m == nil || other == nil {
		return
	}
	for _, key := range other.keys {
		m.Set(key)
	}
}

func (m *OrderedIntSet) Clone() *OrderedIntSet {
	if m == nil {
		return nil
	}
	newSet := &OrderedIntSet{
		keys:   slices.Clone(m.keys),
		values: m.values.Clone(),
	}
	return newSet
}

// Next returns the next key in the set possibly including the given key.
// It returns -1 if the key is not found or if there are no keys greater than the given key.
func (m *OrderedIntSet) Next(i int) int {
	n, ok := m.values.NextSet(uint(i))
	if !ok {
		return -1
	}
	return int(n)
}

// The reason we don't use iter.Seq is https://github.com/golang/go/issues/69015
// This is 70% faster than using iter.Seq2[int, int] for the keys.
// It returns false if the iteration was stopped early.
func (m *OrderedIntSet) ForEachKey(yield func(int) bool) bool {
	if m == nil {
		return true
	}
	for _, key := range m.keys {
		if !yield(key) {
			return false
		}
	}
	return true
}

func (m *OrderedIntSet) Has(key int) bool {
	if m == nil {
		return false
	}
	return m.values.Test(uint(key))
}

func (m *OrderedIntSet) Len() int {
	if m == nil {
		return 0
	}
	return len(m.keys)
}

// KeysSorted returns the keys in sorted order.
func (m *OrderedIntSet) KeysSorted() []int {
	if m == nil {
		return nil
	}
	keys := slices.Clone(m.keys)
	slices.Sort(keys)
	return m.keys
}

func (m *OrderedIntSet) String() string {
	if m == nil {
		return "[]"
	}
	return fmt.Sprintf("%v", m.keys)
}

func (m *OrderedIntSet) Values() *bitset.BitSet {
	if m == nil {
		return nil
	}
	return m.values
}

func (m *OrderedIntSet) IsSuperSet(other *OrderedIntSet) bool {
	if m == nil || other == nil {
		return false
	}
	return m.values.IsSuperSet(other.values)
}

// Words returns the bitset as array of 64-bit words, giving direct access to the internal representation.
// It is not a copy, so changes to the returned slice will affect the bitset.
// It is meant for advanced users.
func (m *OrderedIntSet) Words() []uint64 {
	if m == nil {
		return nil
	}
	return m.values.Words()
}