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
use std::iter::Iterator;
use crate::backends::core::private::math::tensor::{
ck_dim_div, tensor_traits, AsMutTensor, AsRefSlice, AsRefTensor, Tensor,
};
use super::*;
use concrete_commons::numeric::UnsignedInteger;
use concrete_commons::parameters::{MonomialDegree, PolynomialCount, PolynomialSize};
/// A generic polynomial list type.
///
/// This type represents a set of polynomial of homogeneous degree.
///
/// # Example
///
/// ```
/// use concrete_commons::parameters::{PolynomialCount, PolynomialSize};
/// use concrete_core::backends::core::private::math::polynomial::PolynomialList;
/// let list = PolynomialList::from_container(vec![1u8, 2, 3, 4, 5, 6, 7, 8], PolynomialSize(2));
/// assert_eq!(list.polynomial_count(), PolynomialCount(4));
/// assert_eq!(list.polynomial_size(), PolynomialSize(2));
/// ```
#[derive(PartialEq)]
pub struct PolynomialList<Cont> {
pub(crate) tensor: Tensor<Cont>,
pub(crate) poly_size: PolynomialSize,
}
tensor_traits!(PolynomialList);
impl<Coef> PolynomialList<Vec<Coef>>
where
Coef: Copy,
{
/// Allocates a new polynomial list.
///
/// # Example
///
/// ```
/// use concrete_commons::parameters::{PolynomialCount, PolynomialSize};
/// use concrete_core::backends::core::private::math::polynomial::PolynomialList;
/// let list = PolynomialList::allocate(1u8, PolynomialCount(10), PolynomialSize(2));
/// assert_eq!(list.polynomial_count(), PolynomialCount(10));
/// assert_eq!(list.polynomial_size(), PolynomialSize(2));
/// ```
pub fn allocate(value: Coef, number: PolynomialCount, size: PolynomialSize) -> Self {
PolynomialList {
tensor: Tensor::from_container(vec![value; number.0 * size.0]),
poly_size: size,
}
}
}
impl<Cont> PolynomialList<Cont> {
/// Creates a polynomial list from a list of values.
///
/// # Example
///
/// ```
/// use concrete_commons::parameters::{PolynomialCount, PolynomialSize};
/// use concrete_core::backends::core::private::math::polynomial::PolynomialList;
/// let list = PolynomialList::from_container(vec![1u8, 2, 3, 4, 5, 6, 7, 8], PolynomialSize(2));
/// assert_eq!(list.polynomial_count(), PolynomialCount(4));
/// assert_eq!(list.polynomial_size(), PolynomialSize(2));
/// ```
pub fn from_container(cont: Cont, poly_size: PolynomialSize) -> PolynomialList<Cont>
where
Cont: AsRefSlice,
{
ck_dim_div!(cont.as_slice().len() => poly_size.0);
PolynomialList {
tensor: Tensor::from_container(cont),
poly_size,
}
}
/// Returns the number of polynomials in the list.
///
/// # Example
///
/// ```
/// use concrete_commons::parameters::{PolynomialCount, PolynomialSize};
/// use concrete_core::backends::core::private::math::polynomial::PolynomialList;
/// let list = PolynomialList::allocate(1u8, PolynomialCount(10), PolynomialSize(2));
/// assert_eq!(list.polynomial_count(), PolynomialCount(10));
/// ```
pub fn polynomial_count(&self) -> PolynomialCount
where
Self: AsRefTensor,
{
PolynomialCount(self.as_tensor().len() / self.poly_size.0)
}
/// Returns the size of the polynomials in the list.
///
/// # Example
///
/// ```
/// use concrete_commons::parameters::{PolynomialCount, PolynomialSize};
/// use concrete_core::backends::core::private::math::polynomial::PolynomialList;
/// let list = PolynomialList::allocate(1u8, PolynomialCount(10), PolynomialSize(2));
/// assert_eq!(list.polynomial_size(), PolynomialSize(2));
/// ```
pub fn polynomial_size(&self) -> PolynomialSize {
self.poly_size
}
/// Returns a reference to the n-th polynomial of the list.
///
/// # Example
///
/// ```
/// use concrete_commons::parameters::PolynomialSize;
/// use concrete_core::backends::core::private::math::polynomial::{
/// MonomialDegree, PolynomialList,
/// };
/// let list = PolynomialList::from_container(vec![1u8, 2, 3, 4, 5, 6, 7, 8], PolynomialSize(2));
/// let poly = list.get_polynomial(2);
/// assert_eq!(*poly.get_monomial(MonomialDegree(0)).get_coefficient(), 5u8);
/// assert_eq!(*poly.get_monomial(MonomialDegree(1)).get_coefficient(), 6u8);
/// ```
pub fn get_polynomial(&self, n: usize) -> Polynomial<&[<Self as AsRefTensor>::Element]>
where
Self: AsRefTensor,
{
Polynomial {
tensor: self
.as_tensor()
.get_sub((n * self.poly_size.0)..(n + 1) * self.poly_size.0),
}
}
/// Returns a mutable reference to the n-th polynomial of the list.
///
/// # Example
///
/// ```
/// use concrete_commons::parameters::PolynomialSize;
/// use concrete_core::backends::core::private::math::polynomial::{
/// MonomialDegree, PolynomialList,
/// };
/// let mut list =
/// PolynomialList::from_container(vec![1u8, 2, 3, 4, 5, 6, 7, 8], PolynomialSize(2));
/// let mut poly = list.get_mut_polynomial(2);
/// poly.get_mut_monomial(MonomialDegree(0))
/// .set_coefficient(10u8);
/// poly.get_mut_monomial(MonomialDegree(1))
/// .set_coefficient(11u8);
/// let poly = list.get_polynomial(2);
/// assert_eq!(
/// *poly.get_monomial(MonomialDegree(0)).get_coefficient(),
/// 10u8
/// );
/// assert_eq!(
/// *poly.get_monomial(MonomialDegree(1)).get_coefficient(),
/// 11u8
/// );
/// ```
pub fn get_mut_polynomial(
&mut self,
n: usize,
) -> Polynomial<&mut [<Self as AsRefTensor>::Element]>
where
Self: AsMutTensor,
{
let index = (n * self.poly_size.0)..((n + 1) * self.poly_size.0);
Polynomial {
tensor: self.as_mut_tensor().get_sub_mut(index),
}
}
/// Returns an iterator over references to the polynomials contained in the list.
///
/// # Example
///
/// ```
/// use concrete_commons::parameters::PolynomialSize;
/// use concrete_core::backends::core::private::math::polynomial::PolynomialList;
/// let mut list =
/// PolynomialList::from_container(vec![1u8, 2, 3, 4, 5, 6, 7, 8], PolynomialSize(2));
/// for polynomial in list.polynomial_iter() {
/// assert_eq!(polynomial.polynomial_size(), PolynomialSize(2));
/// }
/// assert_eq!(list.polynomial_iter().count(), 4);
/// ```
pub fn polynomial_iter(
&self,
) -> impl Iterator<Item = Polynomial<&[<Self as AsRefTensor>::Element]>>
where
Self: AsRefTensor,
{
self.as_tensor()
.subtensor_iter(self.poly_size.0)
.map(|sub| Polynomial::from_container(sub.into_container()))
}
/// Returns an iterator over mutable references to the polynomials contained in the list.
///
/// # Example
///
/// ```
/// use concrete_commons::parameters::PolynomialSize;
/// use concrete_core::backends::core::private::math::polynomial::{
/// MonomialDegree, PolynomialList,
/// };
/// let mut list =
/// PolynomialList::from_container(vec![1u8, 2, 3, 4, 5, 6, 7, 8], PolynomialSize(2));
/// for mut polynomial in list.polynomial_iter_mut() {
/// polynomial
/// .get_mut_monomial(MonomialDegree(0))
/// .set_coefficient(10u8);
/// assert_eq!(polynomial.polynomial_size(), PolynomialSize(2));
/// }
/// for polynomial in list.polynomial_iter() {
/// assert_eq!(
/// *polynomial.get_monomial(MonomialDegree(0)).get_coefficient(),
/// 10u8
/// );
/// }
/// assert_eq!(list.polynomial_iter_mut().count(), 4);
/// ```
pub fn polynomial_iter_mut(
&mut self,
) -> impl Iterator<Item = Polynomial<&mut [<Self as AsMutTensor>::Element]>>
where
Self: AsMutTensor,
{
let chunks_size = self.poly_size.0;
self.as_mut_tensor()
.subtensor_iter_mut(chunks_size)
.map(|sub| Polynomial::from_container(sub.into_container()))
}
/// Multiplies (mod $(X^N+1)$), all the polynomials of the list with a unit monomial of a
/// given degree.
///
/// # Examples
///
/// ```
/// use concrete_commons::parameters::PolynomialSize;
/// use concrete_core::backends::core::private::math::polynomial::{
/// MonomialDegree, PolynomialList,
/// };
/// let mut list = PolynomialList::from_container(vec![1u8, 2, 3, 4, 5, 6], PolynomialSize(3));
/// list.update_with_wrapping_monic_monomial_mul(MonomialDegree(2));
/// let poly = list.get_polynomial(0);
/// assert_eq!(*poly.get_monomial(MonomialDegree(0)).get_coefficient(), 254);
/// assert_eq!(*poly.get_monomial(MonomialDegree(1)).get_coefficient(), 253);
/// assert_eq!(*poly.get_monomial(MonomialDegree(2)).get_coefficient(), 1);
/// ```
pub fn update_with_wrapping_monic_monomial_mul<Coef>(&mut self, monomial_degree: MonomialDegree)
where
Self: AsMutTensor<Element = Coef>,
Coef: UnsignedInteger,
{
for mut poly in self.polynomial_iter_mut() {
poly.update_with_wrapping_monic_monomial_mul(monomial_degree);
}
}
/// Divides (mod $(X^N+1)$), all the polynomials of the list with a unit monomial of a
/// given degree.
///
/// # Examples
///
/// ```
/// use concrete_commons::parameters::PolynomialSize;
/// use concrete_core::backends::core::private::math::polynomial::{
/// MonomialDegree, PolynomialList,
/// };
/// let mut list = PolynomialList::from_container(vec![1u8, 2, 3, 4, 5, 6], PolynomialSize(3));
/// list.update_with_wrapping_monic_monomial_div(MonomialDegree(2));
/// let poly = list.get_polynomial(0);
/// assert_eq!(*poly.get_monomial(MonomialDegree(0)).get_coefficient(), 3);
/// assert_eq!(*poly.get_monomial(MonomialDegree(1)).get_coefficient(), 255);
/// assert_eq!(*poly.get_monomial(MonomialDegree(2)).get_coefficient(), 254);
/// ```
pub fn update_with_wrapping_monic_monomial_div<Coef>(&mut self, monomial_degree: MonomialDegree)
where
Self: AsMutTensor<Element = Coef>,
Coef: UnsignedInteger,
{
for mut poly in self.polynomial_iter_mut() {
poly.update_with_wrapping_unit_monomial_div(monomial_degree);
}
}
}