Skip to content

Conversation

@connortsui20
Copy link
Contributor

@connortsui20 connortsui20 commented Nov 11, 2025

Removes an incorrect safety doc plus adds an extra comment for the missing width check.

Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
@connortsui20 connortsui20 added the documentation Improvements or additions to documentation label Nov 11, 2025
@connortsui20 connortsui20 changed the title Docs:clear up safety documentation Docs: clear up safety documentation Nov 11, 2025
///
/// # Safety
/// The input slice must be of length `1024 * W / T`, where `T` is the bit-width of Self and `W`
/// is the packed width. The output slice must be of exactly length 1024.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was wrong

@codspeed-hq
Copy link

codspeed-hq bot commented Nov 11, 2025

CodSpeed Performance Report

Merging #102 will degrade performances by 23.76%

Comparing ct/safety-docs (fb498f7) with develop (81e9c70)

Summary

⚡ 7 improvements
❌ 7 regressions
✅ 22 untouched
⏩ 16 skipped1

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark BASE HEAD Change
pack_16_to_3_stack 1.7 µs 2.2 µs -23.76%
unchecked_unpack_16_from_3_stack 2.6 µs 3 µs -12.68%
unpack_16_from_3_stack 2.5 µs 2.9 µs -13.22%
bitpacking_cmp_seq[u16] 5.8 µs 5.2 µs +10.04%
bitpacking_cmp_seq[u32] 5.2 µs 4.2 µs +23.62%
bitpacking_cmp_seq[u64] 7.5 µs 5.6 µs +33.7%
bitpacking_cmp_unpack[u16] 3.1 µs 2.6 µs +16.55%
bitpacking_cmp_unpack[u32] 5.2 µs 4.3 µs +21.07%
bitpacking_cmp_unpack[u64] 9.5 µs 7.7 µs +23.85%
for_pack_16_to_3_stack 2.3 µs 1.8 µs +29.28%
unchecked_unfor_pack_16_from_3_stack 2.7 µs 3.2 µs -13.85%
unchecked_unpack_then_add_reference_16_from_3_stack 3.4 µs 3.8 µs -11.5%
unfor_pack_16_from_3_stack 2.5 µs 3 µs -14.7%
unpack_then_add_reference_16_from_3_stack 3.2 µs 3.7 µs -11.98%

Footnotes

  1. 16 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@robert3005 robert3005 merged commit d12386c into develop Nov 19, 2025
3 of 4 checks passed
@robert3005 robert3005 deleted the ct/safety-docs branch November 19, 2025 16:07
This was referenced Nov 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants