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
use crate::{
logic::ops::{AddLogic, DivLogic, MulLogic, NegLogic, RemLogic, SubLogic},
std::ops::{Add, Div, Mul, Neg, Rem, Sub},
*,
};
/// An unbounded, mathematical integer.
///
/// This type cannot be only be constructed in logical or ghost code.
///
/// # Integers in pearlite
///
/// Note that in pearlite, all integer literals are of type `Int`:
/// ```
/// # use creusot_contracts::*;
/// let x = 1i32;
/// // ↓ need to use the view operator to convert `i32` to `Int`
/// proof_assert!(x@ == 1);
/// ```
///
/// You can use the usual operators on integers: `+`, `-`, `*`, `/` and `%`.
///
/// Note that those operators are _not_ available in ghost code.
#[trusted]
#[cfg_attr(
creusot,
rustc_diagnostic_item = "creusot_int",
creusot::builtins = "prelude.prelude.Int.int"
)]
#[allow(dead_code)]
pub struct Int(*mut ());
impl crate::Clone for Int {
#[trusted]
#[pure]
#[ensures(result == *self)]
fn clone(&self) -> Self {
*self
}
}
impl Copy for Int {}
impl Int {
/// Create a new `Int` value
///
/// The result is wrapped in a [`GhostBox`], so that it can only be access inside a
/// [`ghost!`] block.
///
/// You should not have to use this method directly: instead, use the `int` suffix
/// inside of a `ghost` block:
/// ```
/// # use creusot_contracts::*;
/// let x: GhostBox<Int> = ghost!(1int);
/// ghost! {
/// let y: Int = 2int;
/// };
/// ```
#[trusted]
#[pure]
#[ensures(*result == value@)]
#[allow(unreachable_code)]
#[allow(unused_variables)]
pub fn new(value: i128) -> GhostBox<Self> {
ghost!(panic!())
}
/// Compute `self^p`.
///
/// # Example
///
/// ```
/// # use creusot_contracts::*;
/// proof_assert!(2.pow(3) == 8);
/// ```
#[trusted]
#[logic]
#[creusot::builtins = "int.Power.power"]
#[allow(unused_variables)]
pub fn pow(self, p: Int) -> Int {
dead
}
/// Compute the maximum of `self` and `x`.
///
/// # Example
///
/// ```
/// # use creusot_contracts::*;
/// proof_assert!(10.max(2) == 10);
/// ```
#[trusted]
#[logic]
#[creusot::builtins = "int.MinMax.max"]
#[allow(unused_variables)]
pub fn max(self, x: Int) -> Int {
dead
}
/// Compute the minimum of `self` and `x`.
///
/// # Example
///
/// ```
/// # use creusot_contracts::*;
/// proof_assert!(10.max(2) == 2);
/// ```
#[logic]
#[creusot::builtins = "int.MinMax.min"]
#[trusted]
#[allow(unused_variables)]
pub fn min(self, x: Int) -> Int {
dead
}
/// Compute the euclidean division of `self` by `d`.
///
/// # Example
///
/// ```
/// # use creusot_contracts::*;
/// proof_assert!(10.div_euclid(3) == 3);
/// ```
#[trusted]
#[logic]
#[creusot::builtins = "int.EuclideanDivision.div"]
#[allow(unused_variables)]
pub fn div_euclid(self, d: Int) -> Int {
dead
}
/// Compute the remainder of the euclidean division of `self` by `d`.
///
/// # Example
///
/// ```
/// # use creusot_contracts::*;
/// proof_assert!(10.rem_euclid(3) == 1);
/// ```
#[trusted]
#[logic]
#[creusot::builtins = "int.EuclideanDivision.mod"]
#[allow(unused_variables)]
pub fn rem_euclid(self, d: Int) -> Int {
dead
}
/// Compute the absolute difference of `self` and `x`.
///
/// # Example
///
/// ```
/// # use creusot_contracts::*;
/// proof_assert!(10.abs_diff(3) == 7);
/// proof_assert!(3.abs_diff(10) == 7);
/// proof_assert!((-5).abs_diff(5) == 10);
/// ```
#[logic]
#[open]
pub fn abs_diff(self, other: Int) -> Int {
if self < other {
other - self
} else {
self - other
}
}
}
impl AddLogic for Int {
type Output = Self;
#[logic]
#[trusted]
#[creusot::no_translate]
#[creusot::builtins = "add_int"]
#[allow(unused_variables)]
fn add(self, other: Self) -> Self {
dead
}
}
impl SubLogic for Int {
type Output = Self;
#[logic]
#[trusted]
#[creusot::no_translate]
#[creusot::builtins = "sub_int"]
#[allow(unused_variables)]
fn sub(self, other: Self) -> Self {
dead
}
}
impl MulLogic for Int {
type Output = Self;
#[logic]
#[trusted]
#[creusot::no_translate]
#[creusot::builtins = "mul_int"]
#[allow(unused_variables)]
fn mul(self, other: Self) -> Self {
dead
}
}
impl DivLogic for Int {
type Output = Self;
#[logic]
#[trusted]
#[creusot::no_translate]
#[creusot::builtins = "div_int"]
#[allow(unused_variables)]
fn div(self, other: Self) -> Self {
dead
}
}
impl RemLogic for Int {
type Output = Self;
#[logic]
#[trusted]
#[creusot::no_translate]
#[creusot::builtins = "rem_int"]
#[allow(unused_variables)]
fn rem(self, other: Self) -> Self {
dead
}
}
impl NegLogic for Int {
type Output = Self;
#[logic]
#[trusted]
#[creusot::no_translate]
#[creusot::builtins = "neg_int"]
fn neg(self) -> Self {
dead
}
}
// ========== Ghost operations =============
impl PartialEq for Int {
#[trusted]
#[pure]
#[ensures(result == (*self == *other))]
#[allow(unused_variables)]
fn eq(&self, other: &Self) -> bool {
unreachable!("BUG: called ghost function in normal code")
}
}
impl Add for Int {
type Output = Int;
#[trusted]
#[pure]
#[ensures(result == self + other)]
#[allow(unused_variables)]
fn add(self, other: Int) -> Self {
unreachable!("BUG: called ghost function in normal code")
}
}
impl Sub for Int {
type Output = Int;
#[trusted]
#[pure]
#[ensures(result == self - other)]
#[allow(unused_variables)]
fn sub(self, other: Int) -> Self {
unreachable!("BUG: called ghost function in normal code")
}
}
impl Mul for Int {
type Output = Int;
#[trusted]
#[pure]
#[ensures(result == self * other)]
#[allow(unused_variables)]
fn mul(self, other: Int) -> Self {
unreachable!("BUG: called ghost function in normal code")
}
}
impl Div for Int {
type Output = Int;
#[trusted]
#[pure]
#[ensures(result == self / other)]
#[allow(unused_variables)]
fn div(self, other: Int) -> Self {
unreachable!("BUG: called ghost function in normal code")
}
}
impl Rem for Int {
type Output = Int;
#[trusted]
#[pure]
#[ensures(result == self % other)]
#[allow(unused_variables)]
fn rem(self, other: Int) -> Self {
unreachable!("BUG: called ghost function in normal code")
}
}
impl Neg for Int {
type Output = Int;
#[trusted]
#[pure]
#[ensures(result == -self)]
fn neg(self) -> Self {
unreachable!("BUG: called ghost function in normal code")
}
}