concrete.fhe.values.value_description.md

module concrete.fhe.values.value_description

Declaration of ValueDescription class.

---

class ValueDescription

ValueDescription class, to combine data type, shape, and encryption status into a single object.

method __init__

__init__(dtype: BaseDataType, shape: Tuple[int, ], is_encrypted: bool)

---

property is_clear

Get whether the value is clear or not.

Returns: bool: True if value is not encrypted, False otherwise

---

property is_scalar

Get whether the value is scalar or not.

Returns: bool: True if shape of the value is (), False otherwise

---

property ndim

Get number of dimensions of the value.

Returns: int: number of dimensions of the value

---

property size

Get number of elements in the value.

Returns: int: number of elements in the value

---

method of

of(value: Any, is_encrypted: bool = False) → ValueDescription

Get the ValueDescription that can represent value.

Args: value (Any): value that needs to be represented

is_encrypted (bool, default = False): whether the resulting ValueDescription is encrypted or not

Returns: ValueDescription: ValueDescription that can represent value

Raises: ValueError: if value cannot be represented by ValueDescription