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

77 lines
2.1 KiB
Markdown

<!-- markdownlint-disable -->
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_decrypter.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
# <kbd>module</kbd> `concrete.compiler.simulated_value_decrypter`
SimulatedValueDecrypter.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_decrypter.py#L19"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `SimulatedValueDecrypter`
A helper class to decrypt `Value`s.
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_decrypter.py#L22"><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_decrypter: SimulatedValueDecrypter)
```
Wrap the native C++ object.
**Args:**
value_decrypter (_SimulatedValueDecrypter): object to wrap
**Raises:**
TypeError: if `value_decrypter` is not of type `_SimulatedValueDecrypter`
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_decrypter.py#L52"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `decrypt`
```python
decrypt(position: int, value: Value) Union[int, ndarray]
```
Decrypt value.
**Args:**
position (int): position of the argument within the circuit
value (Value): value to decrypt
**Returns:**
Union[int, np.ndarray]: decrypted value
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_decrypter.py#L42"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `new`
```python
new(client_parameters: ClientParameters, circuit_name: str = 'main')
```
Create a value decrypter.