Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › hash_map › HashMapUnmanaged › getOrPutAssumeCapacityAdapted Public Function getOrPutAssumeCapacityAdapted Doc Source Public Function std.hash_map.HashMapUnmanaged.getOrPutAssumeCapacityAdapted
pub fn getOrPutAssumeCapacityAdapted (self : *Self , key : anytype , ctx : anytype ) GetOrPutResult Params File hash_map.zig: 1143
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198 pub fn getOrPutAssumeCapacityAdapted (self : *Self , key : anytype , ctx : anytype ) GetOrPutResult {
// If you get a compile error on this line, it means that your generic hash
// function is invalid for these parameters.
const hash : Hash = ctx .hash (key );
const mask = self .capacity () - 1 ;
const fingerprint = Metadata .takeFingerprint (hash );
var limit = self .capacity ();
var idx = @as (usize , @truncate (hash & mask ));
var first_tombstone_idx : usize = self .capacity (); // invalid index
var metadata = self .metadata .? + idx ;
while (!metadata [0 ].isFree () and limit != 0 ) {
if (metadata [0 ].isUsed () and metadata [0 ].fingerprint == fingerprint ) {
const test_key = &self .keys ()[idx ];
// If you get a compile error on this line, it means that your generic eql
// function is invalid for these parameters.
if (ctx .eql (key , test_key .*)) {
return GetOrPutResult {
.key_ptr = test_key ,
.value_ptr = &self .values ()[idx ],
.found_existing = true ,
};
}
} else if (first_tombstone_idx == self .capacity () and metadata [0 ].isTombstone ()) {
first_tombstone_idx = idx ;
}
limit -= 1 ;
idx = (idx + 1 ) & mask ;
metadata = self .metadata .? + idx ;
}
if (first_tombstone_idx < self .capacity ()) {
// Cheap try to lower probing lengths after deletions. Recycle a tombstone.
idx = first_tombstone_idx ;
metadata = self .metadata .? + idx ;
}
// We're using a slot previously free or a tombstone.
self .available -= 1 ;
metadata [0 ].fill (fingerprint );
const new_key = &self .keys ()[idx ];
const new_value = &self .values ()[idx ];
new_key .* = undefined ;
new_value .* = undefined ;
self .size += 1 ;
return GetOrPutResult {
.key_ptr = new_key ,
.value_ptr = new_value ,
.found_existing = false ,
};
}