-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Bits | ||
|
||
[![Build Status](https://travis-ci.org/rfourquet/Bits.jl.svg?branch=master)](https://travis-ci.org/rfourquet/Bits.jl) | ||
|
||
This package implements functions to play with bits, of integers, and of floats to a certain extent. | ||
For example: | ||
```julia | ||
julia> bits(0b110101011) | ||
|00000001 10101011| | ||
|
||
julia> ans[1:4] | ||
|1011| | ||
``` | ||
|
||
Currently, the following functions are exported: `bit`, `bits`, `bitsize`, `mask`, `masked`, `tstbit`. | ||
They have a docstring, but no HTML documentation is available yet. | ||
|
||
In these functions, the right-most bit of a value has index `1`, but in some applications it's more natural for it to have index `0`. | ||
So the functions will likely be also implemented with indexes starting at `0`, and both alternatives will be available. | ||
It's possible that the default will be changed. |