Skip to content

Commit 645154c

Browse files
committed
Staging v0.4.0
1 parent 94bb15e commit 645154c

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "bva"
3-
version = "0.3.0"
3+
version = "0.4.0"
44
authors = ["Charles Hubain <[email protected]>"]
55
edition = "2021"
66
rust-version = "1.61"

README.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The result will always have the type and the length of the left hand side operan
3232
hand side operand will be zero extended if needed. Operations will wrap-around in the case of
3333
overflows. This should match the behavior of unsigned integer arithmetics on CPU registers.
3434

35-
# Examples
35+
## Examples
3636

3737
Bit vectors expose an API similar to Rust `std::collections::Vec`:
3838
```rust
@@ -106,26 +106,33 @@ assert_eq!(fibonnaci::<Bv>(19), Bv::from(4181u32));
106106

107107
## Changelog
108108

109+
* 2024/08/18 - 0.4.0
110+
* 100% function test coverage, 98% line test coverage
111+
* Some bug were fixed in the process
112+
* Better API and proper documentation
113+
* extend, append, prepend, repeat, first, last and sign_extend functions
114+
* Constructing bit vectors from array of integers
115+
* Operation with unsigned integers as right hand side
109116
* 2024/07/07 - 0.3.0
110-
* Multiplication, division and modulo operations
111-
* Various helper functions
112-
* Much more rigorous testing reaching high code coverage.
117+
* Multiplication, division and modulo operations
118+
* Various helper functions
119+
* Much more rigorous testing reaching high code coverage.
113120
* 2023/07/04 - 0.2.0
114-
* Major rewrite using const generics
115-
* Iterator support
121+
* Major rewrite using const generics
122+
* Iterator support
116123
* 2020/12/20 - 0.1.0
117-
* BitVector trait with fixed, dynamic and auto implementations.
118-
* Conversion between all the implementations
119-
* Basic arithmetic operations between the different implementations.
120-
* Reading and writing bit vector in various format.
124+
* BitVector trait with fixed, dynamic and auto implementations.
125+
* Conversion between all the implementations
126+
* Basic arithmetic operations between the different implementations.
127+
* Reading and writing bit vector in various format.
121128

122129
## Roadmap
123130

124-
* Aiming for 100% code coverage.
131+
* no-std support
132+
* More convenience BitVector functions
125133
* Signed operation support.
126134
* Borrowing of bits and bit slice inside a bit vector.
127135
* Numerical algorithms such as gcd, modular exponentiation, ...
128-
* no-std support
129136

130137
## Why
131138

0 commit comments

Comments
 (0)