Skip to content

Commit

Permalink
docs: update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
V0ldek committed May 25, 2022
1 parent a371d55 commit 1878f14
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,28 @@

All notable changes to this project will be documented in this file.

## [0.0.4] - 2022-05-25

### Features

#### Support `sse` target feature.
- When the `sse` target feature is enabled
on x86/x86_64 the `SimdBlock` size is 16 bytes,
unless a target feature with a larger vector is also enabled.

Related: [#18](https://github.com/V0ldek/aligners/issues/18)
### Reliability

#### Miri test on windows targets.

#### Added `simd_alignment_test`.
- Test whether the size of `SimdBlock` agrees with the expected one
for a given target.

#### Added simd-size-matrix test.
- Use `simd_alignment_test` to check whether `SimdBlock` sizes
remain consistent across targets.

## [0.0.3] - 2022-05-18


Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# `aligners` – strongly typed memory alignment guarantees

[![Rust](https://github.com/V0ldek/aligners/actions/workflows/rust.yml/badge.svg)](https://github.com/V0ldek/aligners/actions/workflows/rust.yml)
[![Miri](https://github.com/V0ldek/aligners/actions/workflows/miri.yml/badge.svg)](https://github.com/V0ldek/aligners/actions/workflows/miri.yml)
[![docs.rs](https://img.shields.io/docsrs/aligners?logo=docs.rs)](https://docs.rs/aligners)
[![GitHub last commit](https://img.shields.io/github/last-commit/v0ldek/aligners?logo=github)](https://github.com/V0ldek/aligners/commits/main)

[![Crates.io](https://img.shields.io/crates/v/aligners?logo=docs.rs)](https://crates.io/crates/aligners)
[![GitHub Release Date](https://img.shields.io/github/release-date/v0ldek/aligners)](https://github.com/V0ldek/aligners/releases)
[![GitHub last commit](https://img.shields.io/github/last-commit/v0ldek/aligners?logo=github)](https://github.com/V0ldek/aligners/commits/main)

[![Crates.io](https://img.shields.io/crates/l/aligners)](https://choosealicense.com/licenses/mit/)
[![Lines of code](https://img.shields.io/tokei/lines/github/v0ldek/aligners?label=LoC&logo=rust)](https://github.com/V0ldek/aligners/tree/main/src)

Some bytes just need to be aligned. Want to process bytes in batches of 8 by interpreting them as `u64`? They must be 8-byte aligned. Want to run SIMD operations on your bytes? You need to use special unaligned instructions and risk performance, or align them with target's requirements. Maybe your high-performance algorithm requires page alignment?

Expand Down

0 comments on commit 1878f14

Please sign in to comment.