This module contains utilities and data structures for working with enums.
std.enums.A
constant
std.enums.assert
alias
Alias of std.debug.assert
std.enums.BoundedEnumMultiset
type-function
A multiset of enum elements up to CountSize. Backed by an EnumArray. This type does no dynamic allocation and can be copied by value.
pub fn BoundedEnumMultiset(comptime E: type, comptime CountSize: type) type
Parameters
E: type
CountSize: type
Fields
counts: EnumArray(E, CountSize)
std.enums.BoundedEnumMultiset.add
function
Increases the key count by given amount.
pub fn add(self: *Self, key: E, c: CountSize) error{Overflow}!void
Parameters
Errors
- Overflow
std.enums.BoundedEnumMultiset.addAssertSafe
function
Increases the key count by given amount. Caller asserts operation will not overflow.
pub fn addAssertSafe(self: *Self, key: E, c: CountSize) void
Parameters
std.enums.BoundedEnumMultiset.addSet
function
Increases the all key counts by given multiset.
pub fn addSet(self: *Self, other: Self) error{Overflow}!void
Parameters
Errors
- Overflow
std.enums.BoundedEnumMultiset.addSetAssertSafe
function
Increases the all key counts by given multiset. Caller asserts operation will not overflow any key.
pub fn addSetAssertSafe(self: *Self, other: Self) void
Parameters
std.enums.BoundedEnumMultiset.contains
function
Checks if at least one key in multiset.
pub fn contains(self: Self, key: E) bool
Parameters
self: Self
key: E
std.enums.BoundedEnumMultiset.count
function
Returns the total number of key counts in the multiset.
pub fn count(self: Self) usize
Parameters
self: Self
std.enums.BoundedEnumMultiset.empty
constant
A multiset with a count of zero.
Self
std.enums.BoundedEnumMultiset.Entry
constant
std.enums.BoundedEnumMultiset.eql
function
Returns true iff all key counts are the same as given multiset.
pub fn eql(self: Self, other: Self) bool
Parameters
std.enums.BoundedEnumMultiset.getCount
function
Returns the count for a key.
pub fn getCount(self: Self, key: E) CountSize
Parameters
self: Self
key: E
std.enums.BoundedEnumMultiset.init
function
Initializes the multiset using a struct of counts.
pub fn init(init_counts: EnumFieldStruct(E, CountSize, 0)) Self
Parameters
init_counts: EnumFieldStruct(E, CountSize, 0)
std.enums.BoundedEnumMultiset.initWithCount
function
Initializes the multiset with all keys at the same count.
pub fn initWithCount(comptime c: CountSize) Self
Parameters
c: CountSize
std.enums.BoundedEnumMultiset.iterator
function
Returns an iterator over this multiset. Keys with zero counts are included. Modifications to the set during iteration may or may not be observed by the iterator, but will not invalidate it.
pub fn iterator(self: *Self) Iterator
Parameters
self: *Self
std.enums.BoundedEnumMultiset.Iterator
constant
std.enums.BoundedEnumMultiset.minus
function
Returns a multiset with the key count of this multiset minus the corresponding key count in the other multiset. If the other multiset contains more key count than this set, that key will have a count of zero.
pub fn minus(self: Self, other: Self) Self
Parameters
std.enums.BoundedEnumMultiset.plus
function
Returns a multiset with the total key count of this multiset and the other multiset.
pub fn plus(self: Self, other: Self) error{Overflow}!Self
Parameters
Errors
- Overflow
std.enums.BoundedEnumMultiset.plusAssertSafe
function
Returns a multiset with the total key count of this multiset and the other multiset. Caller asserts operation will not overflow any key.
pub fn plusAssertSafe(self: Self, other: Self) Self
Parameters
std.enums.BoundedEnumMultiset.remove
function
Decreases the key count by given amount. If amount is greater than the number of keys in multset, then key count will be set to zero.
pub fn remove(self: *Self, key: E, c: CountSize) void
Parameters
std.enums.BoundedEnumMultiset.removeAll
function
Removes all instance of a key from multiset. Same as setCount(key, 0).
pub fn removeAll(self: *Self, key: E) void
Parameters
self: *Self
key: E
std.enums.BoundedEnumMultiset.removeSet
function
Decreases the all key counts by given multiset. If the given multiset has more key counts than this, then that key will have a key count of zero.
pub fn removeSet(self: *Self, other: Self) void
Parameters
std.enums.BoundedEnumMultiset.Self
alias
Alias of std.enums.BoundedEnumMultiset
std.enums.BoundedEnumMultiset.setCount
function
Set the count for a key.
pub fn setCount(self: *Self, key: E, c: CountSize) void
Parameters
std.enums.BoundedEnumMultiset.subsetOf
function
Returns true iff all key counts less than or equal to the given multiset.
pub fn subsetOf(self: Self, other: Self) bool
Parameters
std.enums.BoundedEnumMultiset.supersetOf
function
Returns true iff all key counts greater than or equal to the given multiset.
pub fn supersetOf(self: Self, other: Self) bool
Parameters
std.enums.directEnumArray
function
Initializes an array of Data which can be indexed by @intCast(usize, @intFromEnum(enum_value)). If the enum is non-exhaustive, the resulting array will only be large enough to hold all explicit fields. If the enum contains any fields with values that cannot be represented by usize, a compile error is issued. The max_unused_slots parameter limits the total number of items which have no matching enum key (holes in the enum numbering). So for example, if an enum has values 1, 2, 5, and 6, max_unused_slots must be at least 3, to allow unused slots 0, 3, and 4. The init_values parameter must be a struct with field names that match the enum values. If the enum has multiple fields with the same value, the name of the first one must be used.
pub fn directEnumArray( comptime E: type, comptime Data: type, comptime max_unused_slots: comptime_int, init_values: EnumFieldStruct(E, Data, null), ) [directEnumArrayLen(E, max_unused_slots)]Data
Parameters
Example usage
test directEnumArray {
const E = enum(i4) { a = 4, b = 6, c = 2 };
var runtime_false: bool = false;
_ = &runtime_false;
const array = directEnumArray(E, bool, 4, .{
.a = true,
.b = runtime_false,
.c = true,
});
try testing.expectEqual([7]bool, @TypeOf(array));
try testing.expectEqual(true, array[4]);
try testing.expectEqual(false, array[6]);
try testing.expectEqual(true, array[2]);
}
std.enums.directEnumArrayDefault
function
Initializes an array of Data which can be indexed by @intCast(usize, @intFromEnum(enum_value)). The enum must be exhaustive. If the enum contains any fields with values that cannot be represented by usize, a compile error is issued. The max_unused_slots parameter limits the total number of items which have no matching enum key (holes in the enum numbering). So for example, if an enum has values 1, 2, 5, and 6, max_unused_slots must be at least 3, to allow unused slots 0, 3, and 4. The init_values parameter must be a struct with field names that match the enum values. If the enum has multiple fields with the same value, the name of the first one must be used.
pub fn directEnumArrayDefault( comptime E: type, comptime Data: type, comptime default: ?Data, comptime max_unused_slots: comptime_int, init_values: EnumFieldStruct(E, Data, default), ) [directEnumArrayLen(E, max_unused_slots)]Data
Parameters
E: type
Data: type
default: ?Data
max_unused_slots: comptime_int
init_values: EnumFieldStruct(E, Data, default)
Example usage
test directEnumArrayDefault {
const E = enum(i4) { a = 4, b = 6, c = 2 };
var runtime_false: bool = false;
_ = &runtime_false;
const array = directEnumArrayDefault(E, bool, false, 4, .{
.a = true,
.b = runtime_false,
});
try testing.expectEqual([7]bool, @TypeOf(array));
try testing.expectEqual(true, array[4]);
try testing.expectEqual(false, array[6]);
try testing.expectEqual(false, array[2]);
}
std.enums.directEnumArrayLen
function
Determines the length of a direct-mapped enum array, indexed by @intCast(usize, @intFromEnum(enum_value)). If the enum is non-exhaustive, the resulting length will only be enough to hold all explicit fields. If the enum contains any fields with values that cannot be represented by usize, a compile error is issued. The max_unused_slots parameter limits the total number of items which have no matching enum key (holes in the enum numbering). So for example, if an enum has values 1, 2, 5, and 6, max_unused_slots must be at least 3, to allow unused slots 0, 3, and 4.
pub fn directEnumArrayLen(comptime E: type, comptime max_unused_slots: comptime_int) comptime_int
Parameters
E: type
max_unused_slots: comptime_int
std.enums.EnumArray
type-function
An array keyed by an enum, backed by a dense array. If the enum is not dense, a mapping will be constructed from enum values to dense indices. This type does no dynamic allocation and can be copied by value.
pub fn EnumArray(comptime E: type, comptime V: type) type
Parameters
E: type
V: type
Fields
std.enums.EnumArray.Entry
container
An entry in the array.
Fields
std.enums.EnumArray.get
function
Returns the value in the array associated with a key.
pub fn get(self: Self, key: Key) Value
Parameters
std.enums.EnumArray.getPtr
function
Returns a pointer to the slot in the array associated with a key.
pub fn getPtr(self: *Self, key: Key) *Value
Parameters
std.enums.EnumArray.getPtrConst
function
Returns a const pointer to the slot in the array associated with a key.
pub fn getPtrConst(self: *const Self, key: Key) *const Value
Parameters
std.enums.EnumArray.Indexer
type
The index mapping for this map
std.enums.EnumArray.init
function
pub fn init(init_values: EnumFieldStruct(E, Value, null)) Self
Parameters
init_values: EnumFieldStruct(E, Value, null)
std.enums.EnumArray.initDefault
function
Initializes values in the enum array, with the specified default.
pub fn initDefault(comptime default: ?Value, init_values: EnumFieldStruct(E, Value, default)) Self
Parameters
default: ?Value
init_values: EnumFieldStruct(E, Value, default)
std.enums.EnumArray.initFill
function
pub fn initFill(v: Value) Self
Parameters
v: Value
std.enums.EnumArray.initUndefined
function
pub fn initUndefined() Self
std.enums.EnumArray.iterator
function
Iterates over the items in the array, in index order.
pub fn iterator(self: *Self) Iterator
Parameters
self: *Self
std.enums.EnumArray.Iterator
container
Fields
std.enums.EnumArray.Iterator.next
function
pub fn next(self: *Iterator) ?Entry
Parameters
self: *Iterator
std.enums.EnumArray.Key
constant
The key type used to index this map
std.enums.EnumArray.len
constant
The number of possible keys in the map
std.enums.EnumArray.Self
alias
Alias of std.enums.EnumArray
std.enums.EnumArray.set
function
Sets the value in the slot associated with a key.
pub fn set(self: *Self, key: Key, value: Value) void
Parameters
std.enums.EnumArray.Value
constant
The value type stored in this map
std.enums.EnumFieldStruct
type-function
Returns a struct with a field matching each unique named enum element. If the enum is extern and has multiple names for the same value, only the first name is used. Each field is of type Data and has the provided default, which may be undefined.
pub fn EnumFieldStruct(comptime E: type, comptime Data: type, comptime field_default: ?Data) type
Parameters
E: type
Data: type
field_default: ?Data
std.enums.EnumIndexer
type-function
pub fn EnumIndexer(comptime E: type) type
Parameters
E: type
std.enums.EnumIndexer.backing_int_sign
constant
std.enums.EnumIndexer.count
constant
comptime_int
std.enums.EnumIndexer.count
constant
comptime_int
std.enums.EnumIndexer.count
constant
comptime_int
std.enums.EnumIndexer.count
constant
comptime_int
std.enums.EnumIndexer.indexOf
function
pub fn indexOf(e: E) usize
Parameters
e: E
std.enums.EnumIndexer.indexOf
function
pub fn indexOf(e: E) usize
Parameters
e: E
std.enums.EnumIndexer.indexOf
function
pub fn indexOf(e: E) usize
Parameters
e: E
std.enums.EnumIndexer.indexOf
function
pub fn indexOf(e: E) usize
Parameters
e: E
std.enums.EnumIndexer.Key
constant
type
std.enums.EnumIndexer.Key
constant
std.enums.EnumIndexer.Key
constant
std.enums.EnumIndexer.Key
constant
std.enums.EnumIndexer.keyForIndex
function
pub fn keyForIndex(i: usize) E
Parameters
i: usize
std.enums.EnumIndexer.keyForIndex
function
pub fn keyForIndex(i: usize) E
Parameters
i: usize
std.enums.EnumIndexer.keyForIndex
function
pub fn keyForIndex(i: usize) E
Parameters
i: usize
std.enums.EnumIndexer.keyForIndex
function
pub fn keyForIndex(i: usize) E
Parameters
i: usize
std.enums.EnumIndexer.lessThan
function
fn lessThan(_: void, a: comptime_int, b: comptime_int) bool
Parameters
_: void
a: comptime_int
b: comptime_int
std.enums.EnumIndexer.max_value
constant
std.enums.EnumIndexer.min_value
constant
std.enums.EnumIndexer.RangeType
constant
std.enums.EnumMap
type-function
A map keyed by an enum, backed by a bitfield and a dense array. If the enum is exhaustive but not dense, a mapping will be constructed from enum values to dense indices. This type does no dynamic allocation and can be copied by value.
Default initialization is deprecated; use .empty instead.
pub fn EnumMap(comptime E: type, comptime V: type) type
Parameters
E: type
V: type
Fields
bits: BitSet = .emptyBits determining whether items are in the map
values: [Indexer.count]Value = undefinedValues of items in the map. If the associated bit is zero, the value is undefined.
Example usage
test EnumMap {
const Ball = enum { red, green, blue };
const none: EnumMap(Ball, u8) = .empty;
try testing.expectEqual(0, none.count());
const some: EnumMap(Ball, u8) = .init(.{
.green = 0xff,
.blue = 0x80,
});
try testing.expectEqual(2, some.count());
try testing.expectEqual(null, some.get(.red));
try testing.expectEqual(0xff, some.get(.green));
try testing.expectEqual(0x80, some.get(.blue));
const all: EnumMap(Ball, u8) = .initFull(0);
try testing.expectEqual(3, all.count());
}
std.enums.EnumMap.BitSet
type
std.enums.EnumMap.contains
function
Checks if the map contains an item.
pub fn contains(self: *const Self, key: Key) bool
Parameters
std.enums.EnumMap.count
function
The number of items in the map.
pub fn count(self: *const Self) usize
Parameters
self: *const Self
std.enums.EnumMap.empty
constant
Self
std.enums.EnumMap.Entry
container
An entry in the map.
Fields
std.enums.EnumMap.fetchPut
function
Sets the value associated with the key in the map, and returns the old value. If the key was not in the map, returns null.
pub fn fetchPut(self: *Self, key: Key, value: Value) ?Value
Parameters
std.enums.EnumMap.fetchRemove
function
Removes a key from the map, and returns the old value. If the key was not in the map, returns null.
pub fn fetchRemove(self: *Self, key: Key) ?Value
Parameters
std.enums.EnumMap.get
function
Gets the value associated with a key. If the key is not in the map, returns null.
pub fn get(self: *const Self, key: Key) ?Value
Parameters
std.enums.EnumMap.getAssertContains
function
Gets the value associated with a key, which must exist in the map.
pub fn getAssertContains(self: *const Self, key: Key) Value
Parameters
std.enums.EnumMap.getPtr
function
Gets the address of the value associated with a key. If the key is not in the map, returns null.
pub fn getPtr(self: *Self, key: Key) ?*Value
Parameters
std.enums.EnumMap.getPtrAssertContains
function
Gets the address of the value associated with a key. The key must be present in the map.
pub fn getPtrAssertContains(self: *Self, key: Key) *Value
Parameters
std.enums.EnumMap.getPtrConst
function
Gets the address of the const value associated with a key. If the key is not in the map, returns null.
pub fn getPtrConst(self: *const Self, key: Key) ?*const Value
Parameters
std.enums.EnumMap.getPtrConstAssertContains
function
Gets the address of the const value associated with a key. The key must be present in the map.
pub fn getPtrConstAssertContains(self: *const Self, key: Key) *const Value
Parameters
std.enums.EnumMap.Indexer
type
The index mapping for this map
std.enums.EnumMap.init
function
Initializes the map using a sparse struct of optionals
pub fn init(init_values: EnumFieldStruct(E, ?Value, @as(?Value, null))) Self
Parameters
init_values: EnumFieldStruct(E, ?Value, @as(?Value, null))
std.enums.EnumMap.initFull
function
Initializes a full mapping with all keys set to value. Consider using EnumArray instead if the map will remain full.
pub fn initFull(value: Value) Self
Parameters
value: Value
std.enums.EnumMap.initFullWith
function
Initializes a full mapping with supplied values. Consider using EnumArray instead if the map will remain full.
pub fn initFullWith(init_values: EnumFieldStruct(E, Value, null)) Self
Parameters
init_values: EnumFieldStruct(E, Value, null)
std.enums.EnumMap.initFullWithDefault
function
Initializes a full mapping with a provided default. Consider using EnumArray instead if the map will remain full.
pub fn initFullWithDefault(comptime default: ?Value, init_values: EnumFieldStruct(E, Value, default)) Self
Parameters
default: ?Value
init_values: EnumFieldStruct(E, Value, default)
std.enums.EnumMap.iterator
function
Returns an iterator over the map, which visits items in index order. Modifications to the underlying map may or may not be observed by the iterator, but will not invalidate it.
pub fn iterator(self: *Self) Iterator
Parameters
self: *Self
std.enums.EnumMap.Iterator
container
Fields
std.enums.EnumMap.Iterator.next
function
pub fn next(self: *Iterator) ?Entry
Parameters
self: *Iterator
std.enums.EnumMap.Key
constant
The key type used to index this map
std.enums.EnumMap.len
constant
The number of possible keys in the map
std.enums.EnumMap.put
function
Adds the key to the map with the supplied value. If the key is already in the map, overwrites the value.
pub fn put(self: *Self, key: Key, value: Value) void
Parameters
std.enums.EnumMap.putUninitialized
function
Adds the key to the map with an undefined value. If the key is already in the map, the value becomes undefined. A pointer to the value is returned, which should be used to initialize the value.
pub fn putUninitialized(self: *Self, key: Key) *Value
Parameters
std.enums.EnumMap.remove
function
Removes a key from the map. If the key was not in the map, does nothing.
pub fn remove(self: *Self, key: Key) void
Parameters
std.enums.EnumMap.Self
alias
Alias of std.enums.EnumMap
std.enums.EnumMap.Value
constant
The value type stored in this map
std.enums.EnumMultiset
type-function
A multiset of enum elements up to a count of usize. Backed by an EnumArray. This type does no dynamic allocation and can be copied by value.
pub fn EnumMultiset(comptime E: type) type
Parameters
E: type
Fields
counts: EnumArray(E, CountSize)
Example usage
test EnumMultiset {
const Ball = enum { red, green, blue };
const empty = EnumMultiset(Ball).empty;
const r0_g1_b2 = EnumMultiset(Ball).init(.{
.red = 0,
.green = 1,
.blue = 2,
});
const ten_of_each = EnumMultiset(Ball).initWithCount(10);
try testing.expectEqual(empty.count(), 0);
try testing.expectEqual(r0_g1_b2.count(), 3);
try testing.expectEqual(ten_of_each.count(), 30);
try testing.expect(!empty.contains(.red));
try testing.expect(!empty.contains(.green));
try testing.expect(!empty.contains(.blue));
try testing.expect(!r0_g1_b2.contains(.red));
try testing.expect(r0_g1_b2.contains(.green));
try testing.expect(r0_g1_b2.contains(.blue));
try testing.expect(ten_of_each.contains(.red));
try testing.expect(ten_of_each.contains(.green));
try testing.expect(ten_of_each.contains(.blue));
{
var copy = ten_of_each;
copy.removeAll(.red);
try testing.expect(!copy.contains(.red));
// removeAll second time does nothing
copy.removeAll(.red);
try testing.expect(!copy.contains(.red));
}
{
var copy = ten_of_each;
copy.addAssertSafe(.red, 6);
try testing.expectEqual(copy.getCount(.red), 16);
}
{
var copy = ten_of_each;
try copy.add(.red, 6);
try testing.expectEqual(copy.getCount(.red), 16);
try testing.expectError(error.Overflow, copy.add(.red, std.math.maxInt(usize)));
}
{
var copy = ten_of_each;
copy.remove(.red, 4);
try testing.expectEqual(copy.getCount(.red), 6);
// subtracting more it contains does not underflow
copy.remove(.green, 14);
try testing.expectEqual(copy.getCount(.green), 0);
}
try testing.expectEqual(empty.getCount(.green), 0);
try testing.expectEqual(r0_g1_b2.getCount(.green), 1);
try testing.expectEqual(ten_of_each.getCount(.green), 10);
{
var copy = empty;
copy.setCount(.red, 6);
try testing.expectEqual(copy.getCount(.red), 6);
}
{
var copy = r0_g1_b2;
copy.addSetAssertSafe(ten_of_each);
try testing.expectEqual(copy.getCount(.red), 10);
try testing.expectEqual(copy.getCount(.green), 11);
try testing.expectEqual(copy.getCount(.blue), 12);
}
{
var copy = r0_g1_b2;
try copy.addSet(ten_of_each);
try testing.expectEqual(copy.getCount(.red), 10);
try testing.expectEqual(copy.getCount(.green), 11);
try testing.expectEqual(copy.getCount(.blue), 12);
const full = EnumMultiset(Ball).initWithCount(std.math.maxInt(usize));
try testing.expectError(error.Overflow, copy.addSet(full));
}
{
var copy = ten_of_each;
copy.removeSet(r0_g1_b2);
try testing.expectEqual(copy.getCount(.red), 10);
try testing.expectEqual(copy.getCount(.green), 9);
try testing.expectEqual(copy.getCount(.blue), 8);
copy.removeSet(ten_of_each);
try testing.expectEqual(copy.getCount(.red), 0);
try testing.expectEqual(copy.getCount(.green), 0);
try testing.expectEqual(copy.getCount(.blue), 0);
}
try testing.expect(empty.eql(empty));
try testing.expect(r0_g1_b2.eql(r0_g1_b2));
try testing.expect(ten_of_each.eql(ten_of_each));
try testing.expect(!empty.eql(r0_g1_b2));
try testing.expect(!r0_g1_b2.eql(ten_of_each));
try testing.expect(!ten_of_each.eql(empty));
try testing.expect(empty.subsetOf(empty));
try testing.expect(r0_g1_b2.subsetOf(r0_g1_b2));
try testing.expect(empty.subsetOf(r0_g1_b2));
try testing.expect(r0_g1_b2.subsetOf(ten_of_each));
try testing.expect(!ten_of_each.subsetOf(r0_g1_b2));
try testing.expect(!r0_g1_b2.subsetOf(empty));
try testing.expect(empty.supersetOf(empty));
try testing.expect(r0_g1_b2.supersetOf(r0_g1_b2));
try testing.expect(r0_g1_b2.supersetOf(empty));
try testing.expect(ten_of_each.supersetOf(r0_g1_b2));
try testing.expect(!r0_g1_b2.supersetOf(ten_of_each));
try testing.expect(!empty.supersetOf(r0_g1_b2));
{
// with multisets it could be the case where two
// multisets are neither subset nor superset of each
// other.
const r10 = EnumMultiset(Ball).init(.{
.red = 10,
});
const b10 = EnumMultiset(Ball).init(.{
.blue = 10,
});
try testing.expect(!r10.subsetOf(b10));
try testing.expect(!b10.subsetOf(r10));
try testing.expect(!r10.supersetOf(b10));
try testing.expect(!b10.supersetOf(r10));
}
{
const result = r0_g1_b2.plusAssertSafe(ten_of_each);
try testing.expectEqual(result.getCount(.red), 10);
try testing.expectEqual(result.getCount(.green), 11);
try testing.expectEqual(result.getCount(.blue), 12);
}
{
const result = try r0_g1_b2.plus(ten_of_each);
try testing.expectEqual(result.getCount(.red), 10);
try testing.expectEqual(result.getCount(.green), 11);
try testing.expectEqual(result.getCount(.blue), 12);
const full = EnumMultiset(Ball).initWithCount(std.math.maxInt(usize));
try testing.expectError(error.Overflow, result.plus(full));
}
{
const result = ten_of_each.minus(r0_g1_b2);
try testing.expectEqual(result.getCount(.red), 10);
try testing.expectEqual(result.getCount(.green), 9);
try testing.expectEqual(result.getCount(.blue), 8);
}
{
const result = ten_of_each.minus(r0_g1_b2).minus(ten_of_each);
try testing.expectEqual(result.getCount(.red), 0);
try testing.expectEqual(result.getCount(.green), 0);
try testing.expectEqual(result.getCount(.blue), 0);
}
{
var copy = empty;
var it = copy.iterator();
var entry = it.next().?;
try testing.expectEqual(entry.key, .red);
try testing.expectEqual(entry.value.*, 0);
entry = it.next().?;
try testing.expectEqual(entry.key, .green);
try testing.expectEqual(entry.value.*, 0);
entry = it.next().?;
try testing.expectEqual(entry.key, .blue);
try testing.expectEqual(entry.value.*, 0);
try testing.expectEqual(it.next(), null);
}
{
var copy = r0_g1_b2;
var it = copy.iterator();
var entry = it.next().?;
try testing.expectEqual(entry.key, .red);
try testing.expectEqual(entry.value.*, 0);
entry = it.next().?;
try testing.expectEqual(entry.key, .green);
try testing.expectEqual(entry.value.*, 1);
entry = it.next().?;
try testing.expectEqual(entry.key, .blue);
try testing.expectEqual(entry.value.*, 2);
try testing.expectEqual(it.next(), null);
}
}
std.enums.EnumSet
type-function
A set of enum elements, backed by a bitfield. If the enum is exhaustive but not dense, a mapping will be constructed from enum values to dense indices. This type does no dynamic allocation and can be copied by value.
pub fn EnumSet(comptime E: type) type
Parameters
E: type
Fields
bits: BitSet = .empty
std.enums.EnumSet.BitSet
type
std.enums.EnumSet.complement
function
Returns a set with all the keys not in this set.
pub fn complement(self: Self) Self
Parameters
self: Self
std.enums.EnumSet.contains
function
Checks if a key is in the set.
pub fn contains(self: Self, key: Key) bool
Parameters
std.enums.EnumSet.count
function
Returns the number of keys in the set.
pub fn count(self: Self) usize
Parameters
self: Self
std.enums.EnumSet.differenceWith
function
Returns a set with keys that are in this set except for keys in the other set.
pub fn differenceWith(self: Self, other: Self) Self
Parameters
std.enums.EnumSet.empty
constant
A set containing no keys.
Self
std.enums.EnumSet.eql
function
Returns true iff both sets have the same keys.
pub fn eql(self: Self, other: Self) bool
Parameters
std.enums.EnumSet.full
constant
A set containing all possible keys.
Self
std.enums.EnumSet.Indexer
type
The indexing rules for converting between keys and indices.
std.enums.EnumSet.init
function
Initializes the set using a struct of bools
pub fn init(init_values: EnumFieldStruct(E, bool, false)) Self
Parameters
init_values: EnumFieldStruct(E, bool, false)
std.enums.EnumSet.initMany
function
Returns a set containing multiple keys.
pub fn initMany(keys: []const Key) Self
Parameters
keys: []const Key
std.enums.EnumSet.initOne
function
Returns a set containing a single key.
pub fn initOne(key: Key) Self
Parameters
key: Key
std.enums.EnumSet.insert
function
Puts a key in the set.
pub fn insert(self: *Self, key: Key) void
Parameters
std.enums.EnumSet.intersectWith
function
Returns a set with keys that are in both this set and the other set.
pub fn intersectWith(self: Self, other: Self) Self
Parameters
std.enums.EnumSet.iterator
function
Returns an iterator over this set, which iterates in index order. Modifications to the set during iteration may or may not be observed by the iterator, but will not invalidate it.
pub fn iterator(self: *const Self) Iterator
Parameters
self: *const Self
std.enums.EnumSet.Iterator
container
Fields
std.enums.EnumSet.Iterator.next
function
pub fn next(self: *Iterator) ?Key
Parameters
self: *Iterator
std.enums.EnumSet.Key
constant
The element type for this set.
std.enums.EnumSet.len
constant
The maximum number of items in this set.
std.enums.EnumSet.remove
function
Removes a key from the set.
pub fn remove(self: *Self, key: Key) void
Parameters
std.enums.EnumSet.Self
alias
Alias of std.enums.EnumSet
std.enums.EnumSet.setIntersection
function
Removes all keys which are not in the passed set.
pub fn setIntersection(self: *Self, other: Self) void
Parameters
std.enums.EnumSet.setPresent
function
Changes the presence of a key in the set to match the passed bool.
pub fn setPresent(self: *Self, key: Key, present: bool) void
Parameters
std.enums.EnumSet.setUnion
function
Adds all keys in the passed set to this set.
pub fn setUnion(self: *Self, other: Self) void
Parameters
std.enums.EnumSet.subsetOf
function
Returns true iff all the keys in this set are in the other set. The other set may have keys not found in this set.
pub fn subsetOf(self: Self, other: Self) bool
Parameters
std.enums.EnumSet.supersetOf
function
Returns true iff this set contains all the keys in the other set. This set may have keys not found in the other set.
pub fn supersetOf(self: Self, other: Self) bool
Parameters
std.enums.EnumSet.toggle
function
Toggles the presence of a key in the set. If the key is in the set, removes it. Otherwise adds it.
pub fn toggle(self: *Self, key: Key) void
Parameters
std.enums.EnumSet.toggleAll
function
Toggles all possible keys in the set.
pub fn toggleAll(self: *Self) void
Parameters
self: *Self
std.enums.EnumSet.toggleSet
function
Toggles the presence of all keys in the passed set.
pub fn toggleSet(self: *Self, other: Self) void
Parameters
std.enums.EnumSet.unionWith
function
Returns a set with keys that are in either this set or the other set.
pub fn unionWith(self: Self, other: Self) Self
Parameters
std.enums.EnumSet.xorWith
function
Returns a set with keys that are in either this set or the other set, but not both.
pub fn xorWith(self: Self, other: Self) Self
Parameters
std.enums.eval_branch_quota_cushion
constant
Increment this value when adding APIs that add single backwards branches.
std.enums.fromInt
function
pub fn fromInt(comptime E: type, integer: anytype) ?E
Parameters
E: type
Example usage
test fromInt {
const E1 = enum {
A,
};
const E2 = enum {
A,
B,
};
const E3 = enum(i8) { A, _ };
const E4 = enum(u8) { A };
var zero: u8 = 0;
var one: u16 = 1;
_ = &zero;
_ = &one;
try testing.expect(fromInt(E1, zero).? == E1.A);
try testing.expect(fromInt(E2, one).? == E2.B);
try testing.expect(fromInt(E3, zero).? == E3.A);
try testing.expect(fromInt(E3, 127).? == @as(E3, @fromBackingInt(@intCast(127))));
try testing.expect(fromInt(E3, -128).? == @as(E3, @fromBackingInt(@intCast(-128))));
try testing.expectEqual(null, fromInt(E1, one));
try testing.expectEqual(null, fromInt(E3, 128));
try testing.expectEqual(null, fromInt(E3, -129));
// `fromInt` used to produce a compiler error instead of `null` if trying to convert an integer
// that wasn't out of range, but also wasn't a valid value.
try testing.expectEqual(null, fromInt(E4, 1));
}
std.enums.std
alias
Alias of std
std.enums.tagName
function
A safe alternative to @tagName() for non-exhaustive enums that doesn't
panic when e has no tagged value.
Returns the tag name for e or null if no tag exists.
pub fn tagName(comptime E: type, e: E) ?[:0]const u8
Parameters
E: type
e: E
Example usage
test tagName {
const E = enum(u8) { a, b, _ };
try testing.expect(tagName(E, .a) != null);
try testing.expectEqualStrings("a", tagName(E, .a).?);
try testing.expect(tagName(E, @as(E, @fromBackingInt(@intCast(42)))) == null);
}
std.enums.testing
alias
Alias of std.testing
std.enums.values
function
Returns the set of all named values in the given enum, in declaration order.
pub inline fn values(comptime E: type) []const E
Parameters
E: type
Example usage
test values {
const E = enum {
X,
Y,
Z,
const A = 1;
};
try testing.expectEqualSlices(E, &.{ .X, .Y, .Z }, values(E));
}
std.enums.valuesFromFields
function
Looks up the supplied field values in the given enum type. The result array is in the same order as the input.
pub inline fn valuesFromFields(comptime E: type, comptime field_values: []const comptime_int) []const E
Parameters
E: type
field_values: []const comptime_int
Source code
std/enums.zig
//! This module contains utilities and data structures for working with enums.
const std = @import("std");
const assert = std.debug.assert;
const testing = std.testing;
/// Increment this value when adding APIs that add single backwards branches.
const eval_branch_quota_cushion = 10;
pub fn fromInt(comptime E: type, integer: anytype) ?E {
const enum_info = @typeInfo(E).@"enum";
if (enum_info.mode == .nonexhaustive) {
if (std.math.cast(enum_info.tag_type, integer)) |tag| {
return @fromBackingInt(@intCast(tag));
}
return null;
}
// We don't directly iterate over the fields of E, as that
// would require an inline loop. Instead, we create an array of
// values that is comptime-know, but can be iterated at runtime
// without requiring an inline loop.
// This generates better machine code.
for (values(E)) |value| {
if (@backingInt(value) == integer) return value;
}
return null;
}
/// Returns a struct with a field matching each unique named enum element.
/// If the enum is extern and has multiple names for the same value, only
/// the first name is used. Each field is of type Data and has the provided
/// default, which may be undefined.
pub fn EnumFieldStruct(comptime E: type, comptime Data: type, comptime field_default: ?Data) type {
@setEvalBranchQuota(@typeInfo(E).@"enum".field_names.len + eval_branch_quota_cushion);
const default_ptr: ?*const anyopaque = if (field_default) |d| @ptrCast(&d) else null;
const field_names = @typeInfo(E).@"enum".field_names;
return @Struct(.auto, null, field_names, &@splat(Data), &@splat(.{ .default_value_ptr = default_ptr }));
}
/// Looks up the supplied field values in the given enum type.
/// The result array is in the same order as the input.
pub inline fn valuesFromFields(comptime E: type, comptime field_values: []const comptime_int) []const E {
comptime {
@setEvalBranchQuota(@typeInfo(E).@"enum".field_names.len + eval_branch_quota_cushion);
var result: [field_values.len]E = undefined;
for (&result, field_values) |*r, f_value| {
r.* = @fromBackingInt(@intCast(f_value));
}
const final = result;
return &final;
}
}
/// Returns the set of all named values in the given enum, in
/// declaration order.
pub inline fn values(comptime E: type) []const E {
return comptime valuesFromFields(E, @typeInfo(E).@"enum".field_values);
}
/// A safe alternative to @tagName() for non-exhaustive enums that doesn't
/// panic when `e` has no tagged value.
/// Returns the tag name for `e` or null if no tag exists.
pub fn tagName(comptime E: type, e: E) ?[:0]const u8 {
const field_names = @typeInfo(E).@"enum".field_names;
const field_values = @typeInfo(E).@"enum".field_values;
@setEvalBranchQuota(field_names.len);
return inline for (field_names, field_values) |f_name, f_value| {
if (@backingInt(e) == f_value) break f_name;
} else null;
}
test tagName {
const E = enum(u8) { a, b, _ };
try testing.expect(tagName(E, .a) != null);
try testing.expectEqualStrings("a", tagName(E, .a).?);
try testing.expect(tagName(E, @as(E, @fromBackingInt(@intCast(42)))) == null);
}
/// Determines the length of a direct-mapped enum array, indexed by
/// @intCast(usize, @intFromEnum(enum_value)).
/// If the enum is non-exhaustive, the resulting length will only be enough
/// to hold all explicit fields.
/// If the enum contains any fields with values that cannot be represented
/// by usize, a compile error is issued. The max_unused_slots parameter limits
/// the total number of items which have no matching enum key (holes in the enum
/// numbering). So for example, if an enum has values 1, 2, 5, and 6, max_unused_slots
/// must be at least 3, to allow unused slots 0, 3, and 4.
pub fn directEnumArrayLen(comptime E: type, comptime max_unused_slots: comptime_int) comptime_int {
var max_value: comptime_int = -1;
const max_usize: comptime_int = ~@as(usize, 0);
const info = @typeInfo(E).@"enum";
for (info.field_names, info.field_values) |f_name, f_value| {
if (f_value < 0) {
@compileError("Cannot create a direct enum array for " ++ @typeName(E) ++ ", field ." ++ f_name ++ " has a negative value.");
}
if (f_value > max_value) {
if (f_value > max_usize) {
@compileError("Cannot create a direct enum array for " ++ @typeName(E) ++ ", field ." ++ f_name ++ " is larger than the max value of usize.");
}
max_value = f_value;
}
}
const unused_slots = max_value + 1 - info.field_names.len;
if (unused_slots > max_unused_slots) {
const unused_str = std.fmt.comptimePrint("{d}", .{unused_slots});
const allowed_str = std.fmt.comptimePrint("{d}", .{max_unused_slots});
@compileError("Cannot create a direct enum array for " ++ @typeName(E) ++ ". It would have " ++ unused_str ++ " unused slots, but only " ++ allowed_str ++ " are allowed.");
}
return max_value + 1;
}
/// Initializes an array of Data which can be indexed by
/// @intCast(usize, @intFromEnum(enum_value)).
/// If the enum is non-exhaustive, the resulting array will only be large enough
/// to hold all explicit fields.
/// If the enum contains any fields with values that cannot be represented
/// by usize, a compile error is issued. The max_unused_slots parameter limits
/// the total number of items which have no matching enum key (holes in the enum
/// numbering). So for example, if an enum has values 1, 2, 5, and 6, max_unused_slots
/// must be at least 3, to allow unused slots 0, 3, and 4.
/// The init_values parameter must be a struct with field names that match the enum values.
/// If the enum has multiple fields with the same value, the name of the first one must
/// be used.
pub fn directEnumArray(
comptime E: type,
comptime Data: type,
comptime max_unused_slots: comptime_int,
init_values: EnumFieldStruct(E, Data, null),
) [directEnumArrayLen(E, max_unused_slots)]Data {
return directEnumArrayDefault(E, Data, null, max_unused_slots, init_values);
}
test directEnumArray {
const E = enum(i4) { a = 4, b = 6, c = 2 };
var runtime_false: bool = false;
_ = &runtime_false;
const array = directEnumArray(E, bool, 4, .{
.a = true,
.b = runtime_false,
.c = true,
});
try testing.expectEqual([7]bool, @TypeOf(array));
try testing.expectEqual(true, array[4]);
try testing.expectEqual(false, array[6]);
try testing.expectEqual(true, array[2]);
}
/// Initializes an array of Data which can be indexed by
/// @intCast(usize, @intFromEnum(enum_value)). The enum must be exhaustive.
/// If the enum contains any fields with values that cannot be represented
/// by usize, a compile error is issued. The max_unused_slots parameter limits
/// the total number of items which have no matching enum key (holes in the enum
/// numbering). So for example, if an enum has values 1, 2, 5, and 6, max_unused_slots
/// must be at least 3, to allow unused slots 0, 3, and 4.
/// The init_values parameter must be a struct with field names that match the enum values.
/// If the enum has multiple fields with the same value, the name of the first one must
/// be used.
pub fn directEnumArrayDefault(
comptime E: type,
comptime Data: type,
comptime default: ?Data,
comptime max_unused_slots: comptime_int,
init_values: EnumFieldStruct(E, Data, default),
) [directEnumArrayLen(E, max_unused_slots)]Data {
const len = comptime directEnumArrayLen(E, max_unused_slots);
var result: [len]Data = @splat(default orelse undefined);
inline for (@typeInfo(@TypeOf(init_values)).@"struct".field_names) |f_name| {
const enum_value = @field(E, f_name);
const index = @as(usize, @intCast(@backingInt(enum_value)));
result[index] = @field(init_values, f_name);
}
return result;
}
test directEnumArrayDefault {
const E = enum(i4) { a = 4, b = 6, c = 2 };
var runtime_false: bool = false;
_ = &runtime_false;
const array = directEnumArrayDefault(E, bool, false, 4, .{
.a = true,
.b = runtime_false,
});
try testing.expectEqual([7]bool, @TypeOf(array));
try testing.expectEqual(true, array[4]);
try testing.expectEqual(false, array[6]);
try testing.expectEqual(false, array[2]);
}
test "directEnumArrayDefault slice" {
const E = enum(i4) { a = 4, b = 6, c = 2 };
var runtime_b = "b";
_ = &runtime_b;
const array = directEnumArrayDefault(E, []const u8, "default", 4, .{
.a = "a",
.b = runtime_b,
});
try testing.expectEqual([7][]const u8, @TypeOf(array));
try testing.expectEqualSlices(u8, "a", array[4]);
try testing.expectEqualSlices(u8, "b", array[6]);
try testing.expectEqualSlices(u8, "default", array[2]);
}
test fromInt {
const E1 = enum {
A,
};
const E2 = enum {
A,
B,
};
const E3 = enum(i8) { A, _ };
const E4 = enum(u8) { A };
var zero: u8 = 0;
var one: u16 = 1;
_ = &zero;
_ = &one;
try testing.expect(fromInt(E1, zero).? == E1.A);
try testing.expect(fromInt(E2, one).? == E2.B);
try testing.expect(fromInt(E3, zero).? == E3.A);
try testing.expect(fromInt(E3, 127).? == @as(E3, @fromBackingInt(@intCast(127))));
try testing.expect(fromInt(E3, -128).? == @as(E3, @fromBackingInt(@intCast(-128))));
try testing.expectEqual(null, fromInt(E1, one));
try testing.expectEqual(null, fromInt(E3, 128));
try testing.expectEqual(null, fromInt(E3, -129));
// `fromInt` used to produce a compiler error instead of `null` if trying to convert an integer
// that wasn't out of range, but also wasn't a valid value.
try testing.expectEqual(null, fromInt(E4, 1));
}
/// A set of enum elements, backed by a bitfield. If the enum
/// is exhaustive but not dense, a mapping will be constructed from enum values
/// to dense indices. This type does no dynamic allocation and
/// can be copied by value.
pub fn EnumSet(comptime E: type) type {
return struct {
const Self = @This();
/// The indexing rules for converting between keys and indices.
pub const Indexer = EnumIndexer(E);
/// The element type for this set.
pub const Key = Indexer.Key;
const BitSet = std.bit_set.Static(Indexer.count);
/// The maximum number of items in this set.
pub const len = Indexer.count;
bits: BitSet = .empty,
/// Initializes the set using a struct of bools
pub fn init(init_values: EnumFieldStruct(E, bool, false)) Self {
@setEvalBranchQuota(2 * @typeInfo(E).@"enum".field_names.len);
var result: Self = .{};
if (@typeInfo(E).@"enum".mode == .exhaustive) {
inline for (0..Self.len) |i| {
const key = comptime Indexer.keyForIndex(i);
const tag = @tagName(key);
if (@field(init_values, tag)) {
result.bits.set(i);
}
}
} else {
inline for (@typeInfo(E).@"enum".field_names) |field_name| {
const key = @field(E, field_name);
if (@field(init_values, field_name)) {
const i = comptime Indexer.indexOf(key);
result.bits.set(i);
}
}
}
return result;
}
/// A set containing no keys.
pub const empty: Self = .{ .bits = .empty };
/// A set containing all possible keys.
pub const full: Self = .{ .bits = .full };
/// Returns a set containing multiple keys.
pub fn initMany(keys: []const Key) Self {
var set: Self = .empty;
for (keys) |key| set.insert(key);
return set;
}
/// Returns a set containing a single key.
pub fn initOne(key: Key) Self {
return initMany(&[_]Key{key});
}
/// Returns the number of keys in the set.
pub fn count(self: Self) usize {
return self.bits.count();
}
/// Checks if a key is in the set.
pub fn contains(self: Self, key: Key) bool {
return self.bits.isSet(Indexer.indexOf(key));
}
/// Puts a key in the set.
pub fn insert(self: *Self, key: Key) void {
self.bits.set(Indexer.indexOf(key));
}
/// Removes a key from the set.
pub fn remove(self: *Self, key: Key) void {
self.bits.unset(Indexer.indexOf(key));
}
/// Changes the presence of a key in the set to match the passed bool.
pub fn setPresent(self: *Self, key: Key, present: bool) void {
self.bits.setValue(Indexer.indexOf(key), present);
}
/// Toggles the presence of a key in the set. If the key is in
/// the set, removes it. Otherwise adds it.
pub fn toggle(self: *Self, key: Key) void {
self.bits.toggle(Indexer.indexOf(key));
}
/// Toggles the presence of all keys in the passed set.
pub fn toggleSet(self: *Self, other: Self) void {
self.bits.toggleSet(other.bits);
}
/// Toggles all possible keys in the set.
pub fn toggleAll(self: *Self) void {
self.bits.toggleAll();
}
/// Adds all keys in the passed set to this set.
pub fn setUnion(self: *Self, other: Self) void {
self.bits.setUnion(other.bits);
}
/// Removes all keys which are not in the passed set.
pub fn setIntersection(self: *Self, other: Self) void {
self.bits.setIntersection(other.bits);
}
/// Returns true iff both sets have the same keys.
pub fn eql(self: Self, other: Self) bool {
return self.bits.eql(other.bits);
}
/// Returns true iff all the keys in this set are
/// in the other set. The other set may have keys
/// not found in this set.
pub fn subsetOf(self: Self, other: Self) bool {
return self.bits.subsetOf(other.bits);
}
/// Returns true iff this set contains all the keys
/// in the other set. This set may have keys not
/// found in the other set.
pub fn supersetOf(self: Self, other: Self) bool {
return self.bits.supersetOf(other.bits);
}
/// Returns a set with all the keys not in this set.
pub fn complement(self: Self) Self {
return .{ .bits = self.bits.complement() };
}
/// Returns a set with keys that are in either this
/// set or the other set.
pub fn unionWith(self: Self, other: Self) Self {
return .{ .bits = self.bits.unionWith(other.bits) };
}
/// Returns a set with keys that are in both this
/// set and the other set.
pub fn intersectWith(self: Self, other: Self) Self {
return .{ .bits = self.bits.intersectWith(other.bits) };
}
/// Returns a set with keys that are in either this
/// set or the other set, but not both.
pub fn xorWith(self: Self, other: Self) Self {
return .{ .bits = self.bits.xorWith(other.bits) };
}
/// Returns a set with keys that are in this set
/// except for keys in the other set.
pub fn differenceWith(self: Self, other: Self) Self {
return .{ .bits = self.bits.differenceWith(other.bits) };
}
/// Returns an iterator over this set, which iterates in
/// index order. Modifications to the set during iteration
/// may or may not be observed by the iterator, but will
/// not invalidate it.
pub fn iterator(self: *const Self) Iterator {
return .{ .inner = self.bits.iterator(.{}) };
}
pub const Iterator = struct {
inner: BitSet.Iterator(.{}),
pub fn next(self: *Iterator) ?Key {
return if (self.inner.next()) |index|
Indexer.keyForIndex(index)
else
null;
}
};
};
}
/// A map keyed by an enum, backed by a bitfield and a dense array.
/// If the enum is exhaustive but not dense, a mapping will be constructed from
/// enum values to dense indices. This type does no dynamic
/// allocation and can be copied by value.
///
/// Default initialization is deprecated; use .empty instead.
pub fn EnumMap(comptime E: type, comptime V: type) type {
return struct {
const Self = @This();
/// The index mapping for this map
pub const Indexer = EnumIndexer(E);
/// The key type used to index this map
pub const Key = Indexer.Key;
/// The value type stored in this map
pub const Value = V;
/// The number of possible keys in the map
pub const len = Indexer.count;
const BitSet = std.bit_set.Static(Indexer.count);
/// Bits determining whether items are in the map
bits: BitSet = .empty,
/// Values of items in the map. If the associated
/// bit is zero, the value is undefined.
values: [Indexer.count]Value = undefined,
pub const empty: Self = .{
.bits = .empty,
.values = undefined,
};
/// Initializes the map using a sparse struct of optionals
pub fn init(init_values: EnumFieldStruct(E, ?Value, @as(?Value, null))) Self {
@setEvalBranchQuota(2 * @typeInfo(E).@"enum".field_names.len);
var result: Self = .{};
if (@typeInfo(E).@"enum".mode == .exhaustive) {
inline for (0..Self.len) |i| {
const key = comptime Indexer.keyForIndex(i);
const tag = @tagName(key);
if (@field(init_values, tag)) |*v| {
result.bits.set(i);
result.values[i] = v.*;
}
}
} else {
inline for (@typeInfo(E).@"enum".field_names) |field_name| {
const key = @field(E, field_name);
if (@field(init_values, field_name)) |*v| {
const i = comptime Indexer.indexOf(key);
result.bits.set(i);
result.values[i] = v.*;
}
}
}
return result;
}
/// Initializes a full mapping with all keys set to value.
/// Consider using EnumArray instead if the map will remain full.
pub fn initFull(value: Value) Self {
return .{
.bits = .full,
.values = @splat(value),
};
}
/// Initializes a full mapping with supplied values.
/// Consider using EnumArray instead if the map will remain full.
pub fn initFullWith(init_values: EnumFieldStruct(E, Value, null)) Self {
return initFullWithDefault(null, init_values);
}
/// Initializes a full mapping with a provided default.
/// Consider using EnumArray instead if the map will remain full.
pub fn initFullWithDefault(comptime default: ?Value, init_values: EnumFieldStruct(E, Value, default)) Self {
@setEvalBranchQuota(2 * @typeInfo(E).@"enum".field_names.len);
var result: Self = .{
.bits = .full,
.values = undefined,
};
inline for (0..Self.len) |i| {
const key = comptime Indexer.keyForIndex(i);
const tag = @tagName(key);
result.values[i] = @field(init_values, tag);
}
return result;
}
/// The number of items in the map.
pub fn count(self: *const Self) usize {
return self.bits.count();
}
/// Checks if the map contains an item.
pub fn contains(self: *const Self, key: Key) bool {
return self.bits.isSet(Indexer.indexOf(key));
}
/// Gets the value associated with a key.
/// If the key is not in the map, returns null.
pub fn get(self: *const Self, key: Key) ?Value {
const index = Indexer.indexOf(key);
return if (self.bits.isSet(index)) self.values[index] else null;
}
/// Gets the value associated with a key, which must
/// exist in the map.
pub fn getAssertContains(self: *const Self, key: Key) Value {
const index = Indexer.indexOf(key);
assert(self.bits.isSet(index));
return self.values[index];
}
/// Gets the address of the value associated with a key.
/// If the key is not in the map, returns null.
pub fn getPtr(self: *Self, key: Key) ?*Value {
const index = Indexer.indexOf(key);
return if (self.bits.isSet(index)) &self.values[index] else null;
}
/// Gets the address of the const value associated with a key.
/// If the key is not in the map, returns null.
pub fn getPtrConst(self: *const Self, key: Key) ?*const Value {
const index = Indexer.indexOf(key);
return if (self.bits.isSet(index)) &self.values[index] else null;
}
/// Gets the address of the value associated with a key.
/// The key must be present in the map.
pub fn getPtrAssertContains(self: *Self, key: Key) *Value {
const index = Indexer.indexOf(key);
assert(self.bits.isSet(index));
return &self.values[index];
}
/// Gets the address of the const value associated with a key.
/// The key must be present in the map.
pub fn getPtrConstAssertContains(self: *const Self, key: Key) *const Value {
const index = Indexer.indexOf(key);
assert(self.bits.isSet(index));
return &self.values[index];
}
/// Adds the key to the map with the supplied value.
/// If the key is already in the map, overwrites the value.
pub fn put(self: *Self, key: Key, value: Value) void {
const index = Indexer.indexOf(key);
self.bits.set(index);
self.values[index] = value;
}
/// Adds the key to the map with an undefined value.
/// If the key is already in the map, the value becomes undefined.
/// A pointer to the value is returned, which should be
/// used to initialize the value.
pub fn putUninitialized(self: *Self, key: Key) *Value {
const index = Indexer.indexOf(key);
self.bits.set(index);
self.values[index] = undefined;
return &self.values[index];
}
/// Sets the value associated with the key in the map,
/// and returns the old value. If the key was not in
/// the map, returns null.
pub fn fetchPut(self: *Self, key: Key, value: Value) ?Value {
const index = Indexer.indexOf(key);
const result: ?Value = if (self.bits.isSet(index)) self.values[index] else null;
self.bits.set(index);
self.values[index] = value;
return result;
}
/// Removes a key from the map. If the key was not in the map,
/// does nothing.
pub fn remove(self: *Self, key: Key) void {
const index = Indexer.indexOf(key);
self.bits.unset(index);
self.values[index] = undefined;
}
/// Removes a key from the map, and returns the old value.
/// If the key was not in the map, returns null.
pub fn fetchRemove(self: *Self, key: Key) ?Value {
const index = Indexer.indexOf(key);
const result: ?Value = if (self.bits.isSet(index)) self.values[index] else null;
self.bits.unset(index);
self.values[index] = undefined;
return result;
}
/// Returns an iterator over the map, which visits items in index order.
/// Modifications to the underlying map may or may not be observed by
/// the iterator, but will not invalidate it.
pub fn iterator(self: *Self) Iterator {
return .{
.inner = self.bits.iterator(.{}),
.values = &self.values,
};
}
/// An entry in the map.
pub const Entry = struct {
/// The key associated with this entry.
/// Modifying this key will not change the map.
key: Key,
/// A pointer to the value in the map associated
/// with this key. Modifications through this
/// pointer will modify the underlying data.
value: *Value,
};
pub const Iterator = struct {
inner: BitSet.Iterator(.{}),
values: *[Indexer.count]Value,
pub fn next(self: *Iterator) ?Entry {
return if (self.inner.next()) |index|
Entry{
.key = Indexer.keyForIndex(index),
.value = &self.values[index],
}
else
null;
}
};
};
}
test EnumMap {
const Ball = enum { red, green, blue };
const none: EnumMap(Ball, u8) = .empty;
try testing.expectEqual(0, none.count());
const some: EnumMap(Ball, u8) = .init(.{
.green = 0xff,
.blue = 0x80,
});
try testing.expectEqual(2, some.count());
try testing.expectEqual(null, some.get(.red));
try testing.expectEqual(0xff, some.get(.green));
try testing.expectEqual(0x80, some.get(.blue));
const all: EnumMap(Ball, u8) = .initFull(0);
try testing.expectEqual(3, all.count());
}
/// A multiset of enum elements up to a count of usize. Backed
/// by an EnumArray. This type does no dynamic allocation and can
/// be copied by value.
pub fn EnumMultiset(comptime E: type) type {
return BoundedEnumMultiset(E, usize);
}
/// A multiset of enum elements up to CountSize. Backed by an
/// EnumArray. This type does no dynamic allocation and can be
/// copied by value.
pub fn BoundedEnumMultiset(comptime E: type, comptime CountSize: type) type {
return struct {
const Self = @This();
counts: EnumArray(E, CountSize),
/// Initializes the multiset using a struct of counts.
pub fn init(init_counts: EnumFieldStruct(E, CountSize, 0)) Self {
@setEvalBranchQuota(2 * @typeInfo(E).@"enum".field_names.len);
var self = initWithCount(0);
const info = @typeInfo(E).@"enum";
inline for (info.field_names, info.field_values) |field_name, field_value| {
const c = @field(init_counts, field_name);
const key: E = @fromBackingInt(@intCast(field_value));
self.counts.set(key, c);
}
return self;
}
/// A multiset with a count of zero.
pub const empty: Self = .initWithCount(0);
/// Initializes the multiset with all keys at the
/// same count.
pub fn initWithCount(comptime c: CountSize) Self {
return .{
.counts = .initDefault(c, .{}),
};
}
/// Returns the total number of key counts in the multiset.
pub fn count(self: Self) usize {
var sum: usize = 0;
for (self.counts.values) |c| {
sum += c;
}
return sum;
}
/// Checks if at least one key in multiset.
pub fn contains(self: Self, key: E) bool {
return self.counts.get(key) > 0;
}
/// Removes all instance of a key from multiset. Same as
/// setCount(key, 0).
pub fn removeAll(self: *Self, key: E) void {
return self.counts.set(key, 0);
}
/// Increases the key count by given amount. Caller asserts
/// operation will not overflow.
pub fn addAssertSafe(self: *Self, key: E, c: CountSize) void {
self.counts.getPtr(key).* += c;
}
/// Increases the key count by given amount.
pub fn add(self: *Self, key: E, c: CountSize) error{Overflow}!void {
self.counts.set(key, try std.math.add(CountSize, self.counts.get(key), c));
}
/// Decreases the key count by given amount. If amount is
/// greater than the number of keys in multset, then key count
/// will be set to zero.
pub fn remove(self: *Self, key: E, c: CountSize) void {
self.counts.getPtr(key).* -= @min(self.getCount(key), c);
}
/// Returns the count for a key.
pub fn getCount(self: Self, key: E) CountSize {
return self.counts.get(key);
}
/// Set the count for a key.
pub fn setCount(self: *Self, key: E, c: CountSize) void {
self.counts.set(key, c);
}
/// Increases the all key counts by given multiset. Caller
/// asserts operation will not overflow any key.
pub fn addSetAssertSafe(self: *Self, other: Self) void {
inline for (@typeInfo(E).@"enum".field_values) |field_value| {
const key = @as(E, @fromBackingInt(@intCast(field_value)));
self.addAssertSafe(key, other.getCount(key));
}
}
/// Increases the all key counts by given multiset.
pub fn addSet(self: *Self, other: Self) error{Overflow}!void {
inline for (@typeInfo(E).@"enum".field_values) |field_value| {
const key = @as(E, @fromBackingInt(@intCast(field_value)));
try self.add(key, other.getCount(key));
}
}
/// Decreases the all key counts by given multiset. If
/// the given multiset has more key counts than this,
/// then that key will have a key count of zero.
pub fn removeSet(self: *Self, other: Self) void {
inline for (@typeInfo(E).@"enum".field_values) |field_value| {
const key = @as(E, @fromBackingInt(@intCast(field_value)));
self.remove(key, other.getCount(key));
}
}
/// Returns true iff all key counts are the same as
/// given multiset.
pub fn eql(self: Self, other: Self) bool {
inline for (@typeInfo(E).@"enum".field_values) |field_value| {
const key = @as(E, @fromBackingInt(@intCast(field_value)));
if (self.getCount(key) != other.getCount(key)) {
return false;
}
}
return true;
}
/// Returns true iff all key counts less than or
/// equal to the given multiset.
pub fn subsetOf(self: Self, other: Self) bool {
inline for (@typeInfo(E).@"enum".field_values) |field_value| {
const key = @as(E, @fromBackingInt(@intCast(field_value)));
if (self.getCount(key) > other.getCount(key)) {
return false;
}
}
return true;
}
/// Returns true iff all key counts greater than or
/// equal to the given multiset.
pub fn supersetOf(self: Self, other: Self) bool {
inline for (@typeInfo(E).@"enum".field_values) |field_value| {
const key = @as(E, @fromBackingInt(@intCast(field_value)));
if (self.getCount(key) < other.getCount(key)) {
return false;
}
}
return true;
}
/// Returns a multiset with the total key count of this
/// multiset and the other multiset. Caller asserts
/// operation will not overflow any key.
pub fn plusAssertSafe(self: Self, other: Self) Self {
var result = self;
result.addSetAssertSafe(other);
return result;
}
/// Returns a multiset with the total key count of this
/// multiset and the other multiset.
pub fn plus(self: Self, other: Self) error{Overflow}!Self {
var result = self;
try result.addSet(other);
return result;
}
/// Returns a multiset with the key count of this
/// multiset minus the corresponding key count in the
/// other multiset. If the other multiset contains
/// more key count than this set, that key will have
/// a count of zero.
pub fn minus(self: Self, other: Self) Self {
var result = self;
result.removeSet(other);
return result;
}
pub const Entry = EnumArray(E, CountSize).Entry;
pub const Iterator = EnumArray(E, CountSize).Iterator;
/// Returns an iterator over this multiset. Keys with zero
/// counts are included. Modifications to the set during
/// iteration may or may not be observed by the iterator,
/// but will not invalidate it.
pub fn iterator(self: *Self) Iterator {
return self.counts.iterator();
}
};
}
test EnumMultiset {
const Ball = enum { red, green, blue };
const empty = EnumMultiset(Ball).empty;
const r0_g1_b2 = EnumMultiset(Ball).init(.{
.red = 0,
.green = 1,
.blue = 2,
});
const ten_of_each = EnumMultiset(Ball).initWithCount(10);
try testing.expectEqual(empty.count(), 0);
try testing.expectEqual(r0_g1_b2.count(), 3);
try testing.expectEqual(ten_of_each.count(), 30);
try testing.expect(!empty.contains(.red));
try testing.expect(!empty.contains(.green));
try testing.expect(!empty.contains(.blue));
try testing.expect(!r0_g1_b2.contains(.red));
try testing.expect(r0_g1_b2.contains(.green));
try testing.expect(r0_g1_b2.contains(.blue));
try testing.expect(ten_of_each.contains(.red));
try testing.expect(ten_of_each.contains(.green));
try testing.expect(ten_of_each.contains(.blue));
{
var copy = ten_of_each;
copy.removeAll(.red);
try testing.expect(!copy.contains(.red));
// removeAll second time does nothing
copy.removeAll(.red);
try testing.expect(!copy.contains(.red));
}
{
var copy = ten_of_each;
copy.addAssertSafe(.red, 6);
try testing.expectEqual(copy.getCount(.red), 16);
}
{
var copy = ten_of_each;
try copy.add(.red, 6);
try testing.expectEqual(copy.getCount(.red), 16);
try testing.expectError(error.Overflow, copy.add(.red, std.math.maxInt(usize)));
}
{
var copy = ten_of_each;
copy.remove(.red, 4);
try testing.expectEqual(copy.getCount(.red), 6);
// subtracting more it contains does not underflow
copy.remove(.green, 14);
try testing.expectEqual(copy.getCount(.green), 0);
}
try testing.expectEqual(empty.getCount(.green), 0);
try testing.expectEqual(r0_g1_b2.getCount(.green), 1);
try testing.expectEqual(ten_of_each.getCount(.green), 10);
{
var copy = empty;
copy.setCount(.red, 6);
try testing.expectEqual(copy.getCount(.red), 6);
}
{
var copy = r0_g1_b2;
copy.addSetAssertSafe(ten_of_each);
try testing.expectEqual(copy.getCount(.red), 10);
try testing.expectEqual(copy.getCount(.green), 11);
try testing.expectEqual(copy.getCount(.blue), 12);
}
{
var copy = r0_g1_b2;
try copy.addSet(ten_of_each);
try testing.expectEqual(copy.getCount(.red), 10);
try testing.expectEqual(copy.getCount(.green), 11);
try testing.expectEqual(copy.getCount(.blue), 12);
const full = EnumMultiset(Ball).initWithCount(std.math.maxInt(usize));
try testing.expectError(error.Overflow, copy.addSet(full));
}
{
var copy = ten_of_each;
copy.removeSet(r0_g1_b2);
try testing.expectEqual(copy.getCount(.red), 10);
try testing.expectEqual(copy.getCount(.green), 9);
try testing.expectEqual(copy.getCount(.blue), 8);
copy.removeSet(ten_of_each);
try testing.expectEqual(copy.getCount(.red), 0);
try testing.expectEqual(copy.getCount(.green), 0);
try testing.expectEqual(copy.getCount(.blue), 0);
}
try testing.expect(empty.eql(empty));
try testing.expect(r0_g1_b2.eql(r0_g1_b2));
try testing.expect(ten_of_each.eql(ten_of_each));
try testing.expect(!empty.eql(r0_g1_b2));
try testing.expect(!r0_g1_b2.eql(ten_of_each));
try testing.expect(!ten_of_each.eql(empty));
try testing.expect(empty.subsetOf(empty));
try testing.expect(r0_g1_b2.subsetOf(r0_g1_b2));
try testing.expect(empty.subsetOf(r0_g1_b2));
try testing.expect(r0_g1_b2.subsetOf(ten_of_each));
try testing.expect(!ten_of_each.subsetOf(r0_g1_b2));
try testing.expect(!r0_g1_b2.subsetOf(empty));
try testing.expect(empty.supersetOf(empty));
try testing.expect(r0_g1_b2.supersetOf(r0_g1_b2));
try testing.expect(r0_g1_b2.supersetOf(empty));
try testing.expect(ten_of_each.supersetOf(r0_g1_b2));
try testing.expect(!r0_g1_b2.supersetOf(ten_of_each));
try testing.expect(!empty.supersetOf(r0_g1_b2));
{
// with multisets it could be the case where two
// multisets are neither subset nor superset of each
// other.
const r10 = EnumMultiset(Ball).init(.{
.red = 10,
});
const b10 = EnumMultiset(Ball).init(.{
.blue = 10,
});
try testing.expect(!r10.subsetOf(b10));
try testing.expect(!b10.subsetOf(r10));
try testing.expect(!r10.supersetOf(b10));
try testing.expect(!b10.supersetOf(r10));
}
{
const result = r0_g1_b2.plusAssertSafe(ten_of_each);
try testing.expectEqual(result.getCount(.red), 10);
try testing.expectEqual(result.getCount(.green), 11);
try testing.expectEqual(result.getCount(.blue), 12);
}
{
const result = try r0_g1_b2.plus(ten_of_each);
try testing.expectEqual(result.getCount(.red), 10);
try testing.expectEqual(result.getCount(.green), 11);
try testing.expectEqual(result.getCount(.blue), 12);
const full = EnumMultiset(Ball).initWithCount(std.math.maxInt(usize));
try testing.expectError(error.Overflow, result.plus(full));
}
{
const result = ten_of_each.minus(r0_g1_b2);
try testing.expectEqual(result.getCount(.red), 10);
try testing.expectEqual(result.getCount(.green), 9);
try testing.expectEqual(result.getCount(.blue), 8);
}
{
const result = ten_of_each.minus(r0_g1_b2).minus(ten_of_each);
try testing.expectEqual(result.getCount(.red), 0);
try testing.expectEqual(result.getCount(.green), 0);
try testing.expectEqual(result.getCount(.blue), 0);
}
{
var copy = empty;
var it = copy.iterator();
var entry = it.next().?;
try testing.expectEqual(entry.key, .red);
try testing.expectEqual(entry.value.*, 0);
entry = it.next().?;
try testing.expectEqual(entry.key, .green);
try testing.expectEqual(entry.value.*, 0);
entry = it.next().?;
try testing.expectEqual(entry.key, .blue);
try testing.expectEqual(entry.value.*, 0);
try testing.expectEqual(it.next(), null);
}
{
var copy = r0_g1_b2;
var it = copy.iterator();
var entry = it.next().?;
try testing.expectEqual(entry.key, .red);
try testing.expectEqual(entry.value.*, 0);
entry = it.next().?;
try testing.expectEqual(entry.key, .green);
try testing.expectEqual(entry.value.*, 1);
entry = it.next().?;
try testing.expectEqual(entry.key, .blue);
try testing.expectEqual(entry.value.*, 2);
try testing.expectEqual(it.next(), null);
}
}
/// An array keyed by an enum, backed by a dense array.
/// If the enum is not dense, a mapping will be constructed from
/// enum values to dense indices. This type does no dynamic
/// allocation and can be copied by value.
pub fn EnumArray(comptime E: type, comptime V: type) type {
return struct {
const Self = @This();
/// The index mapping for this map
pub const Indexer = EnumIndexer(E);
/// The key type used to index this map
pub const Key = Indexer.Key;
/// The value type stored in this map
pub const Value = V;
/// The number of possible keys in the map
pub const len = Indexer.count;
values: [Indexer.count]Value,
pub fn init(init_values: EnumFieldStruct(E, Value, null)) Self {
return initDefault(null, init_values);
}
/// Initializes values in the enum array, with the specified default.
pub fn initDefault(comptime default: ?Value, init_values: EnumFieldStruct(E, Value, default)) Self {
@setEvalBranchQuota(2 * @typeInfo(E).@"enum".field_names.len);
var result: Self = .{ .values = undefined };
inline for (0..Self.len) |i| {
const key = comptime Indexer.keyForIndex(i);
const tag = @tagName(key);
result.values[i] = @field(init_values, tag);
}
return result;
}
pub fn initUndefined() Self {
return Self{ .values = undefined };
}
pub fn initFill(v: Value) Self {
var self: Self = undefined;
@memset(&self.values, v);
return self;
}
/// Returns the value in the array associated with a key.
pub fn get(self: Self, key: Key) Value {
return self.values[Indexer.indexOf(key)];
}
/// Returns a pointer to the slot in the array associated with a key.
pub fn getPtr(self: *Self, key: Key) *Value {
return &self.values[Indexer.indexOf(key)];
}
/// Returns a const pointer to the slot in the array associated with a key.
pub fn getPtrConst(self: *const Self, key: Key) *const Value {
return &self.values[Indexer.indexOf(key)];
}
/// Sets the value in the slot associated with a key.
pub fn set(self: *Self, key: Key, value: Value) void {
self.values[Indexer.indexOf(key)] = value;
}
/// Iterates over the items in the array, in index order.
pub fn iterator(self: *Self) Iterator {
return .{
.values = &self.values,
};
}
/// An entry in the array.
pub const Entry = struct {
/// The key associated with this entry.
/// Modifying this key will not change the array.
key: Key,
/// A pointer to the value in the array associated
/// with this key. Modifications through this
/// pointer will modify the underlying data.
value: *Value,
};
pub const Iterator = struct {
index: usize = 0,
values: *[Indexer.count]Value,
pub fn next(self: *Iterator) ?Entry {
const index = self.index;
if (index < Indexer.count) {
self.index += 1;
return Entry{
.key = Indexer.keyForIndex(index),
.value = &self.values[index],
};
}
return null;
}
};
};
}
test "pure EnumSet fns" {
const Suit = enum { spades, hearts, clubs, diamonds };
const empty = EnumSet(Suit).empty;
const full = EnumSet(Suit).full;
const black = EnumSet(Suit).initMany(&[_]Suit{ .spades, .clubs });
const red = EnumSet(Suit).initMany(&[_]Suit{ .hearts, .diamonds });
try testing.expect(empty.eql(empty));
try testing.expect(full.eql(full));
try testing.expect(!empty.eql(full));
try testing.expect(!full.eql(empty));
try testing.expect(!empty.eql(black));
try testing.expect(!full.eql(red));
try testing.expect(!red.eql(empty));
try testing.expect(!black.eql(full));
try testing.expect(empty.subsetOf(empty));
try testing.expect(empty.subsetOf(full));
try testing.expect(full.subsetOf(full));
try testing.expect(!black.subsetOf(red));
try testing.expect(!red.subsetOf(black));
try testing.expect(full.supersetOf(full));
try testing.expect(full.supersetOf(empty));
try testing.expect(empty.supersetOf(empty));
try testing.expect(!black.supersetOf(red));
try testing.expect(!red.supersetOf(black));
try testing.expect(empty.complement().eql(full));
try testing.expect(full.complement().eql(empty));
try testing.expect(black.complement().eql(red));
try testing.expect(red.complement().eql(black));
try testing.expect(empty.unionWith(empty).eql(empty));
try testing.expect(empty.unionWith(full).eql(full));
try testing.expect(full.unionWith(full).eql(full));
try testing.expect(full.unionWith(empty).eql(full));
try testing.expect(black.unionWith(red).eql(full));
try testing.expect(red.unionWith(black).eql(full));
try testing.expect(empty.intersectWith(empty).eql(empty));
try testing.expect(empty.intersectWith(full).eql(empty));
try testing.expect(full.intersectWith(full).eql(full));
try testing.expect(full.intersectWith(empty).eql(empty));
try testing.expect(black.intersectWith(red).eql(empty));
try testing.expect(red.intersectWith(black).eql(empty));
try testing.expect(empty.xorWith(empty).eql(empty));
try testing.expect(empty.xorWith(full).eql(full));
try testing.expect(full.xorWith(full).eql(empty));
try testing.expect(full.xorWith(empty).eql(full));
try testing.expect(black.xorWith(red).eql(full));
try testing.expect(red.xorWith(black).eql(full));
try testing.expect(empty.differenceWith(empty).eql(empty));
try testing.expect(empty.differenceWith(full).eql(empty));
try testing.expect(full.differenceWith(full).eql(empty));
try testing.expect(full.differenceWith(empty).eql(full));
try testing.expect(full.differenceWith(red).eql(black));
try testing.expect(full.differenceWith(black).eql(red));
}
test "EnumSet empty" {
const E = enum {};
const empty = EnumSet(E).empty;
const full = EnumSet(E).full;
try std.testing.expect(empty.eql(full));
try std.testing.expect(empty.complement().eql(full));
try std.testing.expect(empty.complement().eql(full.complement()));
try std.testing.expect(empty.eql(full.complement()));
}
test "EnumSet const iterator" {
const Direction = enum { up, down, left, right };
const diag_move = init: {
var move = EnumSet(Direction).empty;
move.insert(.right);
move.insert(.up);
break :init move;
};
var result = EnumSet(Direction).empty;
var it = diag_move.iterator();
while (it.next()) |dir| {
result.insert(dir);
}
try testing.expect(result.eql(diag_move));
}
test "EnumSet non-exhaustive" {
const BitIndices = enum(u4) {
a = 0,
b = 1,
c = 4,
_,
};
const BitField = EnumSet(BitIndices);
var flags = BitField.init(.{ .a = true, .b = true });
flags.insert(.c);
flags.remove(.a);
try testing.expect(!flags.contains(.a));
try testing.expect(flags.contains(.b));
try testing.expect(flags.contains(.c));
}
pub fn EnumIndexer(comptime E: type) type {
// n log n for `std.mem.sortUnstable` call below.
const fields_len = @typeInfo(E).@"enum".field_names.len;
@setEvalBranchQuota(3 * fields_len * std.math.log2(@max(fields_len, 1)) + eval_branch_quota_cushion);
if (@typeInfo(E).@"enum".mode == .nonexhaustive) {
const BackingInt = @typeInfo(E).@"enum".tag_type;
if (@bitSizeOf(BackingInt) > @bitSizeOf(usize))
@compileError("Cannot create an enum indexer for a given non-exhaustive enum, tag_type is larger than usize.");
return struct {
pub const Key: type = E;
const backing_int_sign = @typeInfo(BackingInt).int.signedness;
const min_value = std.math.minInt(BackingInt);
const max_value = std.math.maxInt(BackingInt);
const RangeType = @Int(.unsigned, @bitSizeOf(BackingInt));
pub const count: comptime_int = std.math.maxInt(RangeType) + 1;
pub fn indexOf(e: E) usize {
if (backing_int_sign == .unsigned)
return @backingInt(e);
return if (@backingInt(e) < 0)
@intCast(@backingInt(e) - min_value)
else
@as(RangeType, -min_value) + @as(RangeType, @intCast(@backingInt(e)));
}
pub fn keyForIndex(i: usize) E {
if (backing_int_sign == .unsigned)
return @fromBackingInt(@intCast(i));
return @fromBackingInt(@intCast(@as(@Int(.signed, @bitSizeOf(RangeType) + 1), @intCast(i)) + min_value));
}
};
}
if (fields_len == 0) {
return struct {
pub const Key = E;
pub const count: comptime_int = 0;
pub fn indexOf(e: E) usize {
_ = e;
unreachable;
}
pub fn keyForIndex(i: usize) E {
_ = i;
unreachable;
}
};
}
var field_values = @typeInfo(E).@"enum".field_values[0..fields_len].*;
std.mem.sortUnstable(comptime_int, &field_values, {}, struct {
fn lessThan(_: void, a: comptime_int, b: comptime_int) bool {
return a < b;
}
}.lessThan);
const min = field_values[0];
const max = field_values[fields_len - 1];
if (max - min == field_values.len - 1) {
return struct {
pub const Key = E;
pub const count: comptime_int = fields_len;
pub fn indexOf(e: E) usize {
return @as(usize, @intCast(@backingInt(e) - min));
}
pub fn keyForIndex(i: usize) E {
// TODO fix addition semantics. This calculation
// gives up some safety to avoid artificially limiting
// the range of signed enum values to max_isize.
const enum_value = if (min < 0) @as(isize, @bitCast(i)) +% min else i + min;
return @as(E, @fromBackingInt(@intCast(@as(@typeInfo(E).@"enum".tag_type, @intCast(enum_value)))));
}
};
}
const keys = valuesFromFields(E, &field_values);
return struct {
pub const Key = E;
pub const count: comptime_int = fields_len;
pub fn indexOf(e: E) usize {
for (keys, 0..) |k, i| {
if (k == e) return i;
}
unreachable;
}
pub fn keyForIndex(i: usize) E {
return keys[i];
}
};
}
test "EnumIndexer non-exhaustive" {
const backing_ints = [_]type{
i1,
i2,
i3,
i4,
i8,
i16,
@Int(.signed, @bitSizeOf(isize) - 1),
isize,
u1,
u2,
u3,
u4,
u16,
@Int(.unsigned, @bitSizeOf(usize) - 1),
usize,
};
inline for (backing_ints) |BackingInt| {
const E = enum(BackingInt) {
number_zero_tag = 0,
_,
};
const Indexer = EnumIndexer(E);
const min_tag: E = @fromBackingInt(@intCast(std.math.minInt(BackingInt)));
const max_tag: E = @fromBackingInt(@intCast(std.math.maxInt(BackingInt)));
const RangedType = @Int(.unsigned, @bitSizeOf(BackingInt));
const max_index: comptime_int = std.math.maxInt(RangedType);
const number_zero_tag_index: usize = switch (@typeInfo(BackingInt).int.signedness) {
.unsigned => 0,
.signed => @divCeil(max_index, 2),
};
try testing.expectEqual(E, Indexer.Key);
try testing.expectEqual(max_index + 1, Indexer.count);
try testing.expectEqual(@as(usize, 0), Indexer.indexOf(min_tag));
try testing.expectEqual(number_zero_tag_index, Indexer.indexOf(E.number_zero_tag));
try testing.expectEqual(@as(usize, max_index), Indexer.indexOf(max_tag));
try testing.expectEqual(min_tag, Indexer.keyForIndex(0));
try testing.expectEqual(E.number_zero_tag, Indexer.keyForIndex(number_zero_tag_index));
try testing.expectEqual(max_tag, Indexer.keyForIndex(max_index));
}
}
test "EnumIndexer dense zeroed" {
const E = enum(u2) { b = 1, a = 0, c = 2 };
const Indexer = EnumIndexer(E);
try testing.expectEqual(E, Indexer.Key);
try testing.expectEqual(3, Indexer.count);
try testing.expectEqual(@as(usize, 0), Indexer.indexOf(.a));
try testing.expectEqual(@as(usize, 1), Indexer.indexOf(.b));
try testing.expectEqual(@as(usize, 2), Indexer.indexOf(.c));
try testing.expectEqual(E.a, Indexer.keyForIndex(0));
try testing.expectEqual(E.b, Indexer.keyForIndex(1));
try testing.expectEqual(E.c, Indexer.keyForIndex(2));
}
test "EnumIndexer dense positive" {
const E = enum(u4) { c = 6, a = 4, b = 5 };
const Indexer = EnumIndexer(E);
try testing.expectEqual(E, Indexer.Key);
try testing.expectEqual(3, Indexer.count);
try testing.expectEqual(@as(usize, 0), Indexer.indexOf(.a));
try testing.expectEqual(@as(usize, 1), Indexer.indexOf(.b));
try testing.expectEqual(@as(usize, 2), Indexer.indexOf(.c));
try testing.expectEqual(E.a, Indexer.keyForIndex(0));
try testing.expectEqual(E.b, Indexer.keyForIndex(1));
try testing.expectEqual(E.c, Indexer.keyForIndex(2));
}
test "EnumIndexer dense negative" {
const E = enum(i4) { a = -6, c = -4, b = -5 };
const Indexer = EnumIndexer(E);
try testing.expectEqual(E, Indexer.Key);
try testing.expectEqual(3, Indexer.count);
try testing.expectEqual(@as(usize, 0), Indexer.indexOf(.a));
try testing.expectEqual(@as(usize, 1), Indexer.indexOf(.b));
try testing.expectEqual(@as(usize, 2), Indexer.indexOf(.c));
try testing.expectEqual(E.a, Indexer.keyForIndex(0));
try testing.expectEqual(E.b, Indexer.keyForIndex(1));
try testing.expectEqual(E.c, Indexer.keyForIndex(2));
}
test "EnumIndexer sparse" {
const E = enum(i4) { a = -2, c = 6, b = 4 };
const Indexer = EnumIndexer(E);
try testing.expectEqual(E, Indexer.Key);
try testing.expectEqual(3, Indexer.count);
try testing.expectEqual(@as(usize, 0), Indexer.indexOf(.a));
try testing.expectEqual(@as(usize, 1), Indexer.indexOf(.b));
try testing.expectEqual(@as(usize, 2), Indexer.indexOf(.c));
try testing.expectEqual(E.a, Indexer.keyForIndex(0));
try testing.expectEqual(E.b, Indexer.keyForIndex(1));
try testing.expectEqual(E.c, Indexer.keyForIndex(2));
}
test "EnumIndexer empty" {
const E = enum {};
const Indexer = EnumIndexer(E);
try testing.expectEqual(E, Indexer.Key);
try testing.expectEqual(0, Indexer.count);
}
test "EnumIndexer large dense unsorted" {
@setEvalBranchQuota(500_000); // many `comptimePrint`s
// Make an enum with 500 fields with values in *descending* order.
const E = @Enum(u32, .exhaustive, names: {
var names: [500][]const u8 = undefined;
for (&names, 0..) |*name, i| name.* = std.fmt.comptimePrint("f{d}", .{i});
break :names &names;
}, vals: {
var vals: [500]u32 = undefined;
for (&vals, 0..) |*val, i| val.* = 500 - i;
break :vals &vals;
});
const Indexer = EnumIndexer(E);
try testing.expectEqual(E.f0, Indexer.keyForIndex(499));
try testing.expectEqual(E.f499, Indexer.keyForIndex(0));
try testing.expectEqual(499, Indexer.indexOf(.f0));
try testing.expectEqual(0, Indexer.indexOf(.f499));
}
test values {
const E = enum {
X,
Y,
Z,
const A = 1;
};
try testing.expectEqualSlices(E, &.{ .X, .Y, .Z }, values(E));
}