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 › compress › zstd › Decompress › LiteralsSection › HuffmanTree › assignWeights Private Function assignWeights Doc Source Private Function std.compress.zstd.Decompress.LiteralsSection.HuffmanTree.assignWeights
fn assignWeights (
huff_bits_buffer : []const u8 ,
accuracy_log : u16 ,
entries : *[1 << 6 ]Table .Fse ,
weights : *[256 ]u4 ,
) !usize Params huff_bits_buffer : []const u8 accuracy_log : u16 entries : *[1 << 6 ]Table .Fse weights : *[256 ]u4 File compress/zstd/Decompress.zig: 1152
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 fn assignWeights (
huff_bits_buffer : []const u8 ,
accuracy_log : u16 ,
entries : *[1 << 6 ]Table .Fse ,
weights : *[256 ]u4 ,
) !usize {
var huff_bits = try ReverseBitReader .init (huff_bits_buffer );
var i : usize = 0 ;
var even_state : u32 = try huff_bits .readBitsNoEof (u32 , accuracy_log );
var odd_state : u32 = try huff_bits .readBitsNoEof (u32 , accuracy_log );
while (i < 254 ) {
const even_data = entries [even_state ];
var read_bits : u16 = 0 ;
const even_bits = huff_bits .readBits (u32 , even_data .bits , &read_bits ) catch unreachable ;
weights [i ] = std .math .cast (u4 , even_data .symbol ) orelse return error .MalformedHuffmanTree ;
i += 1 ;
if (read_bits < even_data .bits ) {
weights [i ] = std .math .cast (u4 , entries [odd_state ].symbol ) orelse return error .MalformedHuffmanTree ;
i += 1 ;
break ;
}
even_state = even_data .baseline + even_bits ;
read_bits = 0 ;
const odd_data = entries [odd_state ];
const odd_bits = huff_bits .readBits (u32 , odd_data .bits , &read_bits ) catch unreachable ;
weights [i ] = std .math .cast (u4 , odd_data .symbol ) orelse return error .MalformedHuffmanTree ;
i += 1 ;
if (read_bits < odd_data .bits ) {
if (i == 255 ) return error .MalformedHuffmanTree ;
weights [i ] = std .math .cast (u4 , entries [even_state ].symbol ) orelse return error .MalformedHuffmanTree ;
i += 1 ;
break ;
}
odd_state = odd_data .baseline + odd_bits ;
} else return error .MalformedHuffmanTree ;
if (!huff_bits .isEmpty ()) {
return error .MalformedHuffmanTree ;
}
return i + 1 ; // stream contains all but the last symbol
}