Files
concrete/docs/dev/api/concrete.fhe.extensions.bits.md
Benoit Chevallier-Mames 2424352dbf docs(compiler): update apidocs
2024-04-15 09:37:48 +02:00

59 lines
1.6 KiB
Markdown

<!-- markdownlint-disable -->
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/extensions/bits.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
# <kbd>module</kbd> `concrete.fhe.extensions.bits`
Bit extraction extensions.
**Global Variables**
---------------
- **MIN_EXTRACTABLE_BIT**
- **MAX_EXTRACTABLE_BIT**
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/extensions/bits.py#L155"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `bits`
```python
bits(x: Union[int, integer, list, ndarray, Tracer]) Bits
```
Extract bits of integers.
**Args:**
x (Union[int, np.integer, list, np.ndarray, Tracer]): input to extract bits from
**Returns:**
Bits: Auxiliary class to represent bits of the integer
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/extensions/bits.py#L19"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Bits`
Bits class, to provide indexing into the bits of integers.
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/extensions/bits.py#L26"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
```python
__init__(value: Union[int, integer, list, ndarray, Tracer])
```