Files
concrete/docs/dev/api/concrete.fhe.internal.utils.md
Benoit Chevallier-Mames e37a840e7e docs(compiler): adding API doc
2024-03-13 17:10:00 +01:00

47 lines
1.3 KiB
Markdown

<!-- markdownlint-disable -->
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/internal/utils.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.internal.utils`
Declaration of various functions and constants related to the entire project.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/internal/utils.py#L6"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `assert_that`
```python
assert_that(condition: bool, message: str = '')
```
Assert a condition.
**Args:**
condition (bool): condition to assert
message (str): message to give to `AssertionError` if the condition does not hold
**Raises:**
AssertionError: if the condition does not hold
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/internal/utils.py#L26"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `unreachable`
```python
unreachable()
```
Raise a RuntimeError to indicate unreachable code is entered.