1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
use super::inner::RadixCiphertext;
use crate::conformance::ParameterSetConformant;
use crate::high_level_api::global_state;
use crate::high_level_api::integers::{FheUint, FheUintId, IntegerId};
use crate::high_level_api::keys::InternalServerKey;
use crate::integer::client_key::RecomposableSignedInteger;
use crate::integer::parameters::RadixCiphertextConformanceParams;
use crate::named::Named;
use crate::prelude::CastFrom;
use crate::shortint::ciphertext::NotTrivialCiphertextError;
use crate::shortint::PBSParameters;
use crate::{Device, FheBool, ServerKey};
use std::marker::PhantomData;
#[cfg(feature = "gpu")]
use crate::high_level_api::global_state::with_thread_local_cuda_stream;
pub trait FheIntId: IntegerId {}
/// A Generic FHE signed integer
///
/// This struct is generic over some ID, as it's the ID
/// that controls how many bit they represent.
///
/// You will need to use one of this type specialization (e.g., [FheInt8], [FheInt16]).
///
/// Its the type that overloads the operators (`+`, `-`, `*`),
/// since the `FheInt` type is not `Copy` the operators are also overloaded
/// to work with references.
///
/// [FheInt8]: crate::high_level_api::FheUint8
/// [FheInt16]: crate::high_level_api::FheInt16
#[cfg_attr(all(doc, not(doctest)), doc(cfg(feature = "integer")))]
#[derive(Clone, serde::Deserialize, serde::Serialize)]
pub struct FheInt<Id: FheIntId> {
pub(in crate::high_level_api) ciphertext: RadixCiphertext,
pub(in crate::high_level_api::integers) id: Id,
}
pub struct FheIntConformanceParams<Id: FheIntId> {
pub(crate) params: RadixCiphertextConformanceParams,
pub(crate) id: PhantomData<Id>,
}
impl<Id: FheIntId, P: Into<PBSParameters>> From<P> for FheIntConformanceParams<Id> {
fn from(params: P) -> Self {
let params = params.into();
Self {
params: RadixCiphertextConformanceParams {
shortint_params: params.to_shortint_conformance_param(),
num_blocks_per_integer: Id::num_blocks(params.message_modulus()),
},
id: PhantomData,
}
}
}
impl<Id: FheIntId> From<&ServerKey> for FheIntConformanceParams<Id> {
fn from(sk: &ServerKey) -> Self {
Self {
params: RadixCiphertextConformanceParams {
shortint_params: sk.key.pbs_key().key.conformance_params(),
num_blocks_per_integer: Id::num_blocks(sk.key.pbs_key().message_modulus()),
},
id: PhantomData,
}
}
}
impl<Id: FheIntId> ParameterSetConformant for FheInt<Id> {
type ParameterSet = FheIntConformanceParams<Id>;
fn is_conformant(&self, params: &FheIntConformanceParams<Id>) -> bool {
self.ciphertext.on_cpu().is_conformant(¶ms.params)
}
}
impl<Id: FheIntId> Named for FheInt<Id> {
const NAME: &'static str = "high_level_api::FheInt";
}
impl<Id> FheInt<Id>
where
Id: FheIntId,
{
pub(in crate::high_level_api) fn new(ciphertext: impl Into<RadixCiphertext>) -> Self {
Self {
ciphertext: ciphertext.into(),
id: Id::default(),
}
}
pub fn into_raw_parts(self) -> (crate::integer::SignedRadixCiphertext, Id) {
let Self { ciphertext, id } = self;
(ciphertext.into_cpu(), id)
}
pub fn from_raw_parts(ciphertext: crate::integer::SignedRadixCiphertext, id: Id) -> Self {
Self {
ciphertext: ciphertext.into(),
id,
}
}
/// Moves (in-place) the ciphertext to the desired device.
///
/// Does nothing if the ciphertext is already in the desired device
pub fn move_to_device(&mut self, device: Device) {
self.ciphertext.move_to_device(device)
}
/// Returns the device where the ciphertext is currently on
pub fn current_device(&self) -> Device {
self.ciphertext.current_device()
}
/// Returns the absolute value
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheInt16};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheInt16::encrypt(-3i16, &client_key);
/// let result: i16 = a.abs().decrypt(&client_key);
/// assert_eq!(result, (-3i16).wrapping_abs());
///
/// let a = FheInt16::encrypt(3i16, &client_key);
/// let result: i16 = a.abs().decrypt(&client_key);
/// assert_eq!(result, (-3i16).wrapping_abs());
///
/// // The abs of the minimum cannot be represented
/// // and overflows to itself
/// let a = FheInt16::encrypt(i16::MIN, &client_key);
/// let result: i16 = a.abs().decrypt(&client_key);
/// assert_eq!(result, i16::MIN.wrapping_abs());
/// ```
pub fn abs(&self) -> Self {
global_state::with_internal_keys(|keys| match keys {
InternalServerKey::Cpu(cpu_key) => {
let ciphertext = cpu_key
.pbs_key()
.abs_parallelized(&*self.ciphertext.on_cpu());
Self::new(ciphertext)
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(_) => {
panic!("Cuda devices does not support abs yet")
}
})
}
/// Returns the number of leading zeros in the binary representation of self.
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheBool, FheInt16};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheInt16::encrypt(-1i16, &client_key);
///
/// let result = a.leading_zeros();
/// let decrypted: u32 = result.decrypt(&client_key);
/// assert_eq!(decrypted, 0);
/// ```
pub fn leading_zeros(&self) -> crate::FheUint32 {
global_state::with_internal_keys(|key| match key {
InternalServerKey::Cpu(cpu_key) => {
let result = cpu_key
.pbs_key()
.leading_zeros_parallelized(&*self.ciphertext.on_cpu());
let result = cpu_key.pbs_key().cast_to_unsigned(
result,
crate::FheUint32Id::num_blocks(cpu_key.pbs_key().message_modulus()),
);
crate::FheUint32::new(result)
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(_) => {
panic!("Cuda devices do not support leading_zeros yet");
}
})
}
/// Returns the number of leading ones in the binary representation of self.
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheBool, FheInt16};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheInt16::encrypt(-1i16, &client_key);
///
/// let result = a.leading_ones();
/// let decrypted: u32 = result.decrypt(&client_key);
/// assert_eq!(decrypted, 16);
/// ```
pub fn leading_ones(&self) -> crate::FheUint32 {
global_state::with_internal_keys(|key| match key {
InternalServerKey::Cpu(cpu_key) => {
let result = cpu_key
.pbs_key()
.leading_ones_parallelized(&*self.ciphertext.on_cpu());
let result = cpu_key.pbs_key().cast_to_unsigned(
result,
crate::FheUint32Id::num_blocks(cpu_key.pbs_key().message_modulus()),
);
crate::FheUint32::new(result)
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(_) => {
panic!("Cuda devices do not support leading_ones yet");
}
})
}
/// Returns the number of trailing zeros in the binary representation of self.
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheBool, FheInt16};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheInt16::encrypt(-4i16, &client_key);
///
/// let result = a.trailing_zeros();
/// let decrypted: u32 = result.decrypt(&client_key);
/// assert_eq!(decrypted, 2);
/// ```
pub fn trailing_zeros(&self) -> crate::FheUint32 {
global_state::with_internal_keys(|key| match key {
InternalServerKey::Cpu(cpu_key) => {
let result = cpu_key
.pbs_key()
.trailing_zeros_parallelized(&*self.ciphertext.on_cpu());
let result = cpu_key.pbs_key().cast_to_unsigned(
result,
crate::FheUint32Id::num_blocks(cpu_key.pbs_key().message_modulus()),
);
crate::FheUint32::new(result)
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(_) => {
panic!("Cuda devices do not support trailing_zeros yet");
}
})
}
/// Returns the number of trailing ones in the binary representation of self.
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheBool, FheInt16};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheInt16::encrypt(3i16, &client_key);
///
/// let result = a.trailing_ones();
/// let decrypted: u32 = result.decrypt(&client_key);
/// assert_eq!(decrypted, 2);
/// ```
pub fn trailing_ones(&self) -> crate::FheUint32 {
global_state::with_internal_keys(|key| match key {
InternalServerKey::Cpu(cpu_key) => {
let result = cpu_key
.pbs_key()
.trailing_ones_parallelized(&*self.ciphertext.on_cpu());
let result = cpu_key.pbs_key().cast_to_unsigned(
result,
crate::FheUint32Id::num_blocks(cpu_key.pbs_key().message_modulus()),
);
crate::FheUint32::new(result)
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(_) => {
panic!("Cuda devices do not support trailing_ones yet");
}
})
}
/// Returns the base 2 logarithm of the number, rounded down.
///
/// Result has no meaning if self encrypts a value <= 0. See [Self::checked_ilog2]
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheBool, FheInt16};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheInt16::encrypt(2i16, &client_key);
///
/// let result = a.ilog2();
/// let decrypted: u32 = result.decrypt(&client_key);
/// assert_eq!(decrypted, 1);
/// ```
pub fn ilog2(&self) -> crate::FheUint32 {
global_state::with_internal_keys(|key| match key {
InternalServerKey::Cpu(cpu_key) => {
let result = cpu_key
.pbs_key()
.ilog2_parallelized(&*self.ciphertext.on_cpu());
let result = cpu_key.pbs_key().cast_to_unsigned(
result,
crate::FheUint32Id::num_blocks(cpu_key.pbs_key().message_modulus()),
);
crate::FheUint32::new(result)
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(_) => {
panic!("Cuda devices do not support ilog2 yet");
}
})
}
/// Returns the base 2 logarithm of the number, rounded down.
///
/// Also returns a boolean flag that is true if the result is valid (i.e self was > 0)
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheBool, FheInt16};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheInt16::encrypt(-1i16, &client_key);
///
/// let (result, is_ok) = a.checked_ilog2();
///
/// let is_ok = is_ok.decrypt(&client_key);
/// assert_eq!(is_ok, false);
///
/// let decrypted: u16 = result.decrypt(&client_key);
/// assert_eq!(decrypted, 15); // result is meaningless
/// ```
pub fn checked_ilog2(&self) -> (crate::FheUint32, FheBool) {
global_state::with_internal_keys(|key| match key {
InternalServerKey::Cpu(cpu_key) => {
let (result, is_ok) = cpu_key
.pbs_key()
.checked_ilog2_parallelized(&*self.ciphertext.on_cpu());
let result = cpu_key.pbs_key().cast_to_unsigned(
result,
crate::FheUint32Id::num_blocks(cpu_key.pbs_key().message_modulus()),
);
(crate::FheUint32::new(result), FheBool::new(is_ok))
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(_) => {
panic!("Cuda devices do not support checked_ilog2 yet");
}
})
}
/// Tries to decrypt a trivial ciphertext
///
/// Trivial ciphertexts are ciphertexts which are not encrypted
/// meaning they can be decrypted by any key, or even without a key.
///
/// For debugging it can be useful to use trivial ciphertext to speed up
/// execution, and use [Self::try_decrypt_trivial] to decrypt temporary values
/// and debug.
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheInt16};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// // This is not a trivial ciphertext as we use a client key to encrypt.
/// let non_trivial = FheInt16::encrypt(-1i16, &client_key);
/// // This is a trivial ciphertext
/// let trivial = FheInt16::encrypt_trivial(-2i16);
///
/// // We can trivial decrypt
/// let result: Result<i16, _> = trivial.try_decrypt_trivial();
/// assert_eq!(result, Ok(-2));
///
/// // We cannot trivial decrypt
/// let result: Result<i16, _> = non_trivial.try_decrypt_trivial();
/// matches!(result, Err(_));
/// ```
pub fn try_decrypt_trivial<Clear>(&self) -> Result<Clear, NotTrivialCiphertextError>
where
Clear: RecomposableSignedInteger,
{
self.ciphertext.on_cpu().decrypt_trivial()
}
}
impl<FromId, IntoId> CastFrom<FheInt<FromId>> for FheInt<IntoId>
where
FromId: FheIntId,
IntoId: FheIntId,
{
/// Cast a FheInt to another FheInt
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheInt16, FheInt32};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheInt32::encrypt(i32::MAX, &client_key);
/// let b = FheInt16::cast_from(a);
///
/// let decrypted: i16 = b.decrypt(&client_key);
/// assert_eq!(decrypted, i32::MAX as i16);
/// ```
fn cast_from(input: FheInt<FromId>) -> Self {
global_state::with_internal_keys(|keys| match keys {
InternalServerKey::Cpu(cpu_key) => {
let target_num_blocks = IntoId::num_blocks(cpu_key.message_modulus());
let new_ciphertext = cpu_key
.pbs_key()
.cast_to_signed(input.ciphertext.into_cpu(), target_num_blocks);
Self::new(new_ciphertext)
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(_) => {
panic!("Cuda devices does not support casting signed to signed yet")
}
})
}
}
impl<FromId, IntoId> CastFrom<FheUint<FromId>> for FheInt<IntoId>
where
FromId: FheUintId,
IntoId: FheIntId,
{
/// Cast a FheUint to a FheInt
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheInt16, FheUint32};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheUint32::encrypt(u32::MAX, &client_key);
/// let b = FheInt16::cast_from(a);
///
/// let decrypted: i16 = b.decrypt(&client_key);
/// assert_eq!(decrypted, u32::MAX as i16);
/// ```
fn cast_from(input: FheUint<FromId>) -> Self {
global_state::with_internal_keys(|keys| match keys {
InternalServerKey::Cpu(cpu_key) => {
let new_ciphertext = cpu_key.key.cast_to_signed(
input.ciphertext.on_cpu().to_owned(),
IntoId::num_blocks(cpu_key.message_modulus()),
);
Self::new(new_ciphertext)
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(_) => {
panic!("Cuda devices does not support casting unsigned to signed yet")
}
})
}
}
impl<Id> CastFrom<FheBool> for FheInt<Id>
where
Id: FheIntId,
{
/// Cast a FheBool to a FheInt
///
/// # Example
///
/// ```rust
/// use tfhe::prelude::*;
/// use tfhe::{generate_keys, set_server_key, ConfigBuilder, FheBool, FheInt16};
///
/// let (client_key, server_key) = generate_keys(ConfigBuilder::default());
/// set_server_key(server_key);
///
/// let a = FheBool::encrypt(true, &client_key);
/// let b = FheInt16::cast_from(a);
///
/// let decrypted: i16 = b.decrypt(&client_key);
/// assert_eq!(decrypted, i16::from(true));
/// ```
fn cast_from(input: FheBool) -> Self {
global_state::with_internal_keys(|keys| match keys {
InternalServerKey::Cpu(cpu_key) => {
let ciphertext = input
.ciphertext
.on_cpu()
.into_owned()
.into_radix::<crate::integer::SignedRadixCiphertext>(
Id::num_blocks(cpu_key.message_modulus()),
cpu_key.pbs_key(),
);
Self::new(ciphertext)
}
#[cfg(feature = "gpu")]
InternalServerKey::Cuda(cuda_key) => with_thread_local_cuda_stream(|stream| {
let inner = cuda_key.key.cast_to_unsigned(
input.ciphertext.into_gpu().0,
Id::num_blocks(cuda_key.message_modulus()),
stream,
);
let inner = crate::integer::gpu::ciphertext::CudaSignedRadixCiphertext::new(
inner.ciphertext.d_blocks,
inner.ciphertext.info,
);
Self::new(inner)
}),
})
}
}