workspace/src/part07.rs

   1 // ***Remember to enable/add this part in `main.rs`!***
   2
   3 // Rust-101, Part 07: Operator Overloading, Tests, Formatting
   4 // ==========================================================
   5
   6 pub use part05::BigInt;
   7
   8 // With our new knowledge of lifetimes, we are now able to write down the desired type
   9 // of `min`: We want the function to take two borrows *of the same lifetime*, and then
  10 // return a borrow of that lifetime. If the two input lifetimes would be different, we
  11 // would not know which lifetime to use for the result.
  12 pub trait Minimum {
  13     fn min<'a>(&'a self, other: &'a Self) -> &'a Self;
  14 }
  15
  16 // Now we can implement a generic function `vec_min` that works on above trait.
  17 // The code is pretty much straight-forward, and Rust checks that all the
  18 // lifetimes actually work out. Observe that we don't have to make any copies!
  19 pub fn vec_min<T: Minimum>(v: &Vec<T>) -> Option<&T> {
  20     let mut min: Option<&T> = None;
  21     for e in v {
  22         min = Some(match min {
  23             None => e,
  24             Some(n) => n.min(e)
  25         });
  26     }
  27     min
  28 }
  29 // Notice that the return type `Option<&T>` is technically (leaving the borrowing story aside) a
  30 // pointer to a `T`, that could optionally be invalid. In other words, it's just like a pointer in
  31 // C(++) or Java that can be `NULL`! However, thanks to `Option` being an `enum`, we cannot forget
  32 // to check the pointer for validity, avoiding the safety issues of C(++).<br/>
  33 // Also, if you are worried about wasting space, notice that Rust knows that `&T` can never be
  34 // `NULL`, and hence optimizes `Option<&T>` to be no larger than `&T`. The `None` case is represented
  35 // as `NULL`. This is another great example of a zero-cost abstraction: `Option<&T>` is exactly like
  36 // a pointer in C(++), if you look at what happens during execution - but it's much safer to use.
  37
  38 // **Exercise 07.1**: For our `vec_min` to be usable with `BigInt`, you will have to provide an implementation of
  39 // `Minimum`. You should be able to pretty much copy the code you wrote for exercise 06.1. You should *not*
  40 // make any copies!
  41 impl Minimum for BigInt {
  42     fn min<'a>(&'a self, other: &'a Self) -> &'a Self {
  43         unimplemented!()
  44     }
  45 }
  46
  47 // ## Operator Overloading
  48 // How can we know that our `min` function actually does what we want it to do? One possibility
  49 // here is to do *testing*. Rust comes with nice built-in support for both unit tests and integration
  50 // tests. However, before we go there, we need to have a way of checking whether the results of function calls are
  51 // correct. In other words, we need to define how to test equality of `BigInt`. Being able to
  52 // test equality is a property of a type, that - you guessed it - Rust expresses as a trait: `PartialEq`.
  53
  54 // Doing this for `BigInt` is fairly easy, thanks to our requirement that there be no trailing zeros. We simply
  55 // re-use the equality test on vectors, which compares all the elements individually.
  56 // The `inline` attribute tells Rust that we will typically want this function to be inlined.
  57 impl PartialEq for BigInt {
  58     #[inline]
  59     fn eq(&self, other: &BigInt) -> bool {
  60         debug_assert!(self.test_invariant() && other.test_invariant());
  61         self.data == other.data
  62     }
  63 }
  64 // Since implementing `PartialEq` is a fairly mechanical business, you can let Rust automate this
  65 // by adding the attribute `derive(PartialEq)` to the type definition. In case you wonder about
  66 // the "partial", I suggest you check out the documentation of [`PartialEq`](http://doc.rust-lang.org/std/cmp/trait.PartialEq.html)
  67 // and [`Eq`](http://doc.rust-lang.org/std/cmp/trait.Eq.html). `Eq` can be automatically derived as well.
  68
  69 // Now we can compare `BigInt`s. Rust treats `PratialEq` special in that it is wired to the operator `==`:
  70 //  That operator can not be used on our numbers! Speaking in C++ terms, we just overloaded the `==` operator
  71 // for `BigInt`. Rust does not have function overloading (i.e., it will not dispatch to different
  72 // functions depending on the type of the argument). Instead, one typically finds (or defines) a
  73 // trait that catches the core characteristic common to all the overloads, and writes a single
  74 // function that's generic in the trait. For example, instead of overloading a function for all
  75 // the ways a string can be represented, one writes a generic functions over [ToString](http://doc.rust-lang.org/std/string/trait.ToString.html).
  76 // Usually, there is a trait like this that fits the purpose - and if there is, this has the great
  77 // advantage that any type *you* write, that can convert to a string, just has to implement
  78 // that trait to be immediately usable with all the functions out there that generalize over `ToString`.
  79 // Compare that to C++ or Java, where the only chance to add a new overloading variant is to
  80 // edit the class of the receiver.
  81 //
  82 // Why can we also use `!=`, even though we just overloaded `==`? The answer lies in what's called a *default implementation*.
  83 // If you check out the documentation of `PartialEq` I linked above, you will see that the trait actually provides
  84 // two methods: `eq` to test equality, and `ne` to test inequality. As you may have guessed, `!=` is wired to `ne`.
  85 // The trait *definition* also provides a default implementation of `ne` to be the negation of `eq`. Hence you can just
  86 // provide `eq`, and `!=` will work fine. Or, if you have a more efficient way of deciding inequality, you can provide
  87 // `ne` for your type yourself.
  88 fn compare_big_ints() {
  89     let b1 = BigInt::new(13);
  90     let b2 = BigInt::new(37);
  91     println!("b1 == b1: {} ; b1 == b2: {}; b1 != b2: {}", b1 == b1, b1 == b2, b1 != b2);
  92 }
  93
  94 // ## Testing
  95 // With our equality test written, we are now ready to write our first testcase. It doesn't get much
  96 // simpler: You just write a function (with no arguments or return value), and give it the `test` attribute.
  97 // `assert!` is like `debug_assert!`, but does not get compiled away in a release build.
  98 #[test]
  99 fn test_min() {
 100     let b1 = BigInt::new(1);
 101     let b2 = BigInt::new(42);
 102     let b3 = BigInt::from_vec(vec![0, 1]);
 103
 104     assert!(*b1.min(&b2) == b1);
 105     assert!(*b3.min(&b2) == b2);
 106 }
 107 // Now run `cargo test` to execute the test. If you implemented `min` correctly, it should all work!
 108
 109 // ## Formatting
 110 // There is also a macro `assert_eq!` that's specialized to test for equality, and that prints the two
 111 // values (left and right) if they differ. To be able to do that, the macro needs to know how to format
 112 // the value for printing. This means that we - guess what? - have to implement an appropriate trait.
 113 // Rust knows about two ways of formatting a value: `Display` is for pretty-printing something in a way
 114 // that users can understand, while `Debug` is meant to show the internal state of data and targeted at
 115 // the programmer. The latter is what we want for `assert_eq!`, so let's get started.
 116
 117 // All formating is handled by [`std::fmt`](http://doc.rust-lang.org/std/fmt/index.html). I won't explain
 118 // all the details, and refer you to the documentation instead.
 119 use std::fmt;
 120
 121 // In the case of `BigInt`, we'd like to just output our internal `data` array, so we
 122 // simply call the formating function of `Vec<u64>`.
 123 impl fmt::Debug for BigInt {
 124     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 125         self.data.fmt(f)
 126     }
 127 }
 128 // `Debug` implementations can be automatically generated using the `derive(Debug)` attribute.
 129
 130 // Now we are ready to use `assert_eq!` to test `vec_min`.
 131 #[test]
 132 fn test_vec_min() {
 133     let b1 = BigInt::new(1);
 134     let b2 = BigInt::new(42);
 135     let b3 = BigInt::from_vec(vec![0, 1]);
 136
 137     let v1 = vec![b2.clone(), b1.clone(), b3.clone()];
 138     let v2 = vec![b2.clone(), b3.clone()];
 139     assert_eq!(vec_min(&v1), Some(&b1));
 140     assert_eq!(vec_min(&v2), Some(&b2));
 141 }
 142
 143 // **Exercise 07.1**: Add some more testcases. In particular, make sure you test the behavior of
 144 // `vec_min` on an empty vector. Also add tests for `BigInt::from_vec` (in particular, removing
 145 // trailing zeros). Finally, break one of your functions in a subtle way and watch the test fail.
 146 //
 147 // **Exercise 07.2**: Go back to your good ol' `SomethingOrNothing`, and implement `Display` for it. (This will,
 148 // of course, need a `Display` bound on `T`.) Then you should be able to use them with `println!` just like you do
 149 // with numbers, and get rid of the inherent functions to print `SomethingOrNothing<i32>` and `SomethingOrNothing<f32>`.
 150
 151 // [index](main.html) | [previous](part06.html) | [next](main.html)