src/part08.rs

   1 // Rust-101, Part 08: Associated Types, Modules
   2 // ============================================
   3
   4 use std::{cmp,ops};
   5 use part05::BigInt;
   6
   7 //@ As our next goal, let us implement addition for our `BigInt`. The main issue here will be dealing with the overflow.
   8 //@ First of all, we will have to detect when an overflow happens. This is stored in a so-called *carry* bit, and we have to carry this
   9 //@ information on to the next pair of digits we add. The core primitive of addition therefore is to add two digits *and* a
  10 //@ carry, and to return the sum digit and the next carry.
  11
  12 // So, let us write a function to "add with carry", and give it the appropriate type. Notice Rust's native support for pairs.
  13 fn overflowing_add(a: u64, b: u64, carry: bool) -> (u64, bool) {
  14     //@ Rust's stanza on integer overflows may be a bit surprising: In general, when we write `a + b`, an overflow is
  15     //@ considered an *error*. If you compile your program in debug mode, Rust will actually check for that error and panic
  16     //@ the program in case of overflows. For performance reasons, no such checks are currently inserted for release builds.
  17     //@ The reason for this is that many serious security vulnerabilities have been caused by integer overflows, so just assuming
  18     //@ "per default" that they are intended is dangerous. <br/>
  19     //@ If you explicitly *do* want an overflow to happen, you can call the `wrapping_add`
  20     //@ function (see [the documentation](https://doc.rust-lang.org/stable/std/primitive.u64.html#method.wrapping_add),
  21     //@ there are similar functions for other arithmetic operations). There are also similar functions
  22     //@ `checked_add` etc. to enforce the overflow check.
  23     let sum = a.wrapping_add(b);
  24     // If an overflow happened, then the sum will be smaller than *both* summands. Without an overflow, of course, it will be
  25     // at least as large as both of them. So, let's just pick one and check.
  26     if sum >= a {
  27         // The addition did not overflow. <br/>
  28         // **Exercise 08.1**: Write the code to handle adding the carry in this case.
  29         let sum_total = sum.wrapping_add(if carry { 1 } else { 0 });/*@@*/
  30         let had_overflow = sum_total < sum;                         /*@@*/
  31         (sum_total, had_overflow)                                   /*@@*/
  32     } else {
  33         // Otherwise, the addition *did* overflow. It is impossible for the addition of the carry
  34         // to overflow again, as we are just adding 0 or 1.
  35         (sum + if carry { 1 } else { 0 }, true)                     /*@*/
  36     }
  37 }
  38
  39 // `overflow_add` is a sufficiently intricate function that a test case is justified.
  40 // This should also help you to check your solution of the exercise.
  41 /*#[test]*/
  42 fn test_overflowing_add() {
  43     assert_eq!(overflowing_add(10, 100, false), (110, false));
  44     assert_eq!(overflowing_add(10, 100, true), (111, false));
  45     assert_eq!(overflowing_add(1 << 63, 1 << 63, false), (0, true));
  46     assert_eq!(overflowing_add(1 << 63, 1 << 63, true), (1, true));
  47     assert_eq!(overflowing_add(1 << 63, (1 << 63) -1 , true), (0, true));
  48 }
  49
  50 // ## Associated Types
  51 //@ Now we are equipped to write the addition function for `BigInt`. As you may have guessed, the `+` operator
  52 //@ is tied to a trait (`std::ops::Add`), which we are going to implement for `BigInt`.
  53 //@
  54 //@ In general, addition need not be homogeneous: You could add things of different types, like vectors and points. So when implementing
  55 //@ `Add` for a type, one has to specify the type of the other operand. In this case, it will also be `BigInt` (and we could have left it
  56 //@ away, since that's the default).
  57 impl ops::Add<BigInt> for BigInt {
  58     //@ Besides static functions and methods, traits can contain *associated types*: This is a type chosen by every particular implementation
  59     //@ of the trait. The methods of the trait can then refer to that type. In the case of addition, it is used to give the type of the result.
  60     //@ (Also see the [documentation of `Add`](https://doc.rust-lang.org/stable/std/ops/trait.Add.html).)
  61     //@
  62     //@ In general, you can consider the two `BigInt` given above (in the `impl` line) *input* types of trait search: When
  63     //@ `a + b` is invoked with `a` having type `T` and `b` having type `U`, Rust tries to find an implementation of `Add` for
  64     //@ `T` where the right-hand type is `U`. The associated types, on the other hand, are *output* types: For every combination
  65     //@ of input types, there's a particular result type chosen by the corresponding implementation of `Add`.
  66
  67     // Here, we choose the result type to be again `BigInt`.
  68     type Output = BigInt;
  69
  70     // Now we can write the actual function performing the addition.
  71     fn add(self, rhs: BigInt) -> Self::Output {
  72         // We know that the result will be *at least* as long as the longer of the two operands,
  73         // so we can create a vector with sufficient capacity to avoid expensive reallocations.
  74         let max_len = cmp::max(self.data.len(), rhs.data.len());
  75         let mut result_vec:Vec<u64> = Vec::with_capacity(max_len);
  76         let mut carry = false; /* the current carry bit */
  77         for i in 0..max_len {
  78             let lhs_val = if i < self.data.len() { self.data[i] } else { 0 };
  79             let rhs_val = if i < rhs.data.len() { rhs.data[i] } else { 0 };
  80             // Compute next digit and carry. Then, store the digit for the result, and the carry for later.
  81             //@ Notice how we can obtain names for the two components of the pair that `overflowing_add` returns.
  82             let (sum, new_carry) = overflowing_add(lhs_val, rhs_val, carry);    /*@*/
  83             result_vec.push(sum);                                               /*@*/
  84             carry = new_carry;                                                  /*@*/
  85         }
  86         // **Exercise 08.2**: Handle the final `carry`, and return the sum.
  87         if carry {                                                              /*@@*/
  88             result_vec.push(1);                                                 /*@@*/
  89         }                                                                       /*@@*/
  90         BigInt { data: result_vec }                                             /*@@*/
  91     }
  92 }
  93
  94 // ## Traits and reference types
  95 //@ If you inspect the addition function above closely, you will notice that it actually consumes ownership of both operands
  96 //@ to produce the result. This is, of course, in general not what we want. We'd rather like to be able to add two `&BigInt`.
  97
  98 // Writing this out becomes a bit tedious, because trait implementations (unlike functions) require full explicit annotation
  99 // of lifetimes. Make sure you understand exactly what the following definition says. Notice that we can implement a trait for
 100 // a reference type!
 101 impl<'a, 'b> ops::Add<&'a BigInt> for &'b BigInt {
 102     type Output = BigInt;
 103     fn add(self, rhs: &'a BigInt) -> Self::Output {
 104         // **Exercise 08.3**: Implement this function.
 105         unimplemented!()
 106     }
 107 }
 108
 109 // **Exercise 08.4**: Implement the two missing combinations of arguments for `Add`. You should not have to duplicate the implementation.
 110
 111 // ## Modules
 112 //@ As you learned, tests can be written right in the middle of your development in Rust. However, it is
 113 //@ considered good style to bundle all tests together. This is particularly useful in cases where
 114 //@ you wrote utility functions for the tests, that no other code should use.
 115
 116 // Rust calls a bunch of definitions that are grouped together a *module*. You can put the tests in a submodule as follows.
 117 //@ The `cfg` attribute controls whether this module is even compiled: If we added some functions that are useful for testing,
 118 //@ Rust would not bother compiling them when you just build your program for normal use. Other than that, tests work as usually.
 119 #[cfg(test)]
 120 mod tests {
 121     use part05::BigInt;
 122
 123     /*#[test]*/
 124     fn test_add() {
 125         let b1 = BigInt::new(1 << 32);
 126         let b2 = BigInt::from_vec(vec![0, 1]);
 127
 128         assert_eq!(&b1 + &b2, BigInt::from_vec(vec![1 << 32, 1]));
 129         // **Exercise 08.5**: Add some more cases to this test.
 130     }
 131 }
 132 //@ As already mentioned, outside of the module, only those items declared public with `pub` may be used. Submodules can access
 133 //@ everything defined in their parents. Modules themselves are also hidden from the outside per default, and can be made public
 134 //@ with `pub`. When you use an identifier (or, more general, a *path* like `mod1::submod::name`), it is interpreted as being
 135 //@ relative to the current module. So, for example, to access `overflowing_add` from within `my_mod`, you would have to give a more
 136 //@ explicit path by writing `super::overflowing_add`, which tells Rust to look in the parent module.
 137 //@
 138 //@ You can make names from other modules available locally with `use`. Per default, `use` works globally, so e.g.
 139 //@ `use std;` imports the *global* name `std`. By adding `super::` or `self::` to the beginning of the path, you make it relative
 140 //@ to the parent or current module, respectively. (You can also explicitly construct an absolute path by starting it with `::`,
 141 //@ e.g., `::std::cmp::min`). You can say `pub use path;` to simultaneously *import* names and make them publicly available to others.
 142 //@ Finally, you can import all public items of a module at once with `use module::*;`.
 143 //@
 144 //@ Modules can be put into separate files with the syntax `mod name;`. To explain this, let me take a small detour through
 145 //@ the Rust compilation process. Cargo starts by invoking`rustc` on the file `src/lib.rs` or `src/main.rs`, depending on whether
 146 //@ you compile an application or a library. When `rustc` encounters a `mod name;`, it looks for the files `name.rs` and
 147 //@ `name/mod.rs` and goes on compiling there. (It is an error for both of them to exist.) You can think of the contents of the
 148 //@ file being embedded at this place. However, only the file where compilation started, and files `name/mod.rs` can load modules
 149 //@ from other files. This ensures that the directory structure mirrors the structure of the modules, with `mod.rs`, `lib.rs`
 150 //@ and `main.rs` representing a directory or crate itself (similar to, e.g., `__init__.py` in Python).
 151
 152 // **Exercise 08.6**: Write a subtraction function, and testcases for it. Decide for yourself how you want to handle negative results.
 153 // For example, you may want to return an `Option`, to panic, or to return `0`.
 154
 155 //@ [index](main.html) | [previous](part07.html) | [raw source](https://www.ralfj.de/git/rust-101.git/blob_plain/HEAD:/workspace/src/part08.rs) | [next](part09.html)