Lab 3-1: Complex number: class declaration
practice (data member / member function)

不過我們的要求還稍微多一點, 每一個抽象的資料型態 (abstract data type) 除了包含所存放的資料以外, 還必須要定義它們所支援的運算, 這樣才能精確地描述這個資料型態, 在這個實習中我們考慮下列的運算:

• 加法 (a + b i) + (c + d i) = (a+c) + (b+d) i
  
• 減法 (a + b i) - (c + d i) = (a-c) + (b-d) i
  
• 乘法 (a + b i) * (c + d i) = (ac-bd) + (ad+bc) i
  
• 除法 (a + b i) / (c + d i) = (ac+bd)/(c*c+d*d) + (-ad+bc)/(c*c+d*d) i
  
• 大小 (複數平面上向量的長度) | a + b i | = (a*a+b*b)^0.5
  
• 相等

1. 請使用滑鼠右鍵在 類別檢視 窗格中點選剛才建立的專案名稱 Lab31,
2. 選擇加入, 類別, 已安裝的範本:C++, 點選 新增 按鈕,
3. 在 類別名稱 欄位填入 Complex 作為新的類別名稱, 勾選 虛擬解構函式 點選 完成 按鈕

此時你可以檢查 類別檢視, 看到新增了一個 Complex 類別, 在 方案總管 中你會看到 Complex.cpp 和 Complex.h, 請在 類別檢視 中以滑鼠左鍵雙擊 Complex 來查看 Complex.h 檔案內類別的宣告 (declaration),

    #pragma once
    class Complex  
    {
    public:
        Complex(void);
        virtual ~Complex(void);
    };

注意: 先前你運用 Visual Studio 寫 C 程式的時候, 主要在 方案總管 窗格中檢視所有的檔案, 不太需要用到 類別檢視窗格, 但是你在寫 C++ 程式時, 如果不使用類別檢視的話, 你會花費很多很多的時間在許多檔案裡尋找你自己寫的程式碼

現在你有兩種選擇來增加這兩個資料成員 (data member),

1. 直接編輯 Complex.h 檔案: 在 class 定義裡加入 private: 以及兩個資料成員變數的宣告
   

   private:
       double m_real;
       double m_imaginary;

2. 透過 Visual Studio 的介面來做: 在 類別檢視 裡找到 Complex 類別, 以右鍵選擇 加入/加入變數, 出現一個對話視窗, 在 存取 欄位中選擇 private, 在 變數型別 欄位中填入可以存放實數座標的型態, 在 變數名稱 欄位中填入剛才取好的變數名稱。 注意在 類別檢視 中你應該立刻可以看到這個資料成員變數, 你也應該可以看到一個鎖頭的圖示出現在變數前面, 知道它代表什麼意思嗎? (如果沒有看到這個鎖頭就錯了)

因為類別外面的程式沒有辦法直接存取剛才製作的兩個資料成員, 為了要能夠有設定 Complex 物件內容(狀態)的界面函式, 我們替這個類別增加一個 setValue(double, double); 的 public 成員函式, 如此就可以初始化物件的內容了

增加一個成員函式也和增加資料成員一樣有兩種作法, 可以自己在 complex.h 以及 complex.cpp 檔案中加入成員函式的宣告和定義, 也可以在 類別檢視 中用右鍵選擇 加入/加入函式, 在 傳回型別 欄位填入函式的回傳值型態, 例如 void, 在 函式名稱 欄位中填入函式的名稱 (例如: setValue), 在 參數型別 欄位中填入參數的型態定義 (例如: double), 在 參數名稱 欄位中填入參數的名稱 (例如: real), 點選加入按鈕, 重複以上兩個步驟再增加第二個參數, 在 存取 欄位中選擇 public, 代表是公開的界面函式, Static, Virtual, Pure 和 Inline 目前都不要選, 最後按下 完成 按鈕。

函式的內容基本上就是

m_real = real;
m_imaginary = imaginary;

Complex x;
x.setValue(13,25); // 13 + 25 i

首先應該先決定這些運算的名稱, 決定這些運算所需要傳入的參數, 所需要傳回的數值型態, 然後決定這些運算是 public 還是 private。

• 我們用 add, subtract, multiply, divide 作為運算的名稱
• 由於這四個運算都需要兩個運算元參與(例如: a + b), 每一個成員函式被呼叫時基本上是表示有第二個複數要和自己這個複數來運算, 例如:

  Complex x, y;
  ...
  x.add(y); // 代表希望把  y 加在 x 這個物件上

• 因此每一個運算應該都需要傳入另外一個 Complex 類別的物件(或是物件指標或是參考)作為參數, 這樣才能計算自己這個複數和傳入的複數的和, 差, 乘積, 以及商, 並把運算的結果存放在自己這個物件裡
  
• 這四個運算中除了除法外只會更改自己這個物件的資料, 不需要傳回任何數值, 除法則可能因為除數是 0 而失敗, 所以我們選擇傳回一 bool 型態的結果來表示成功或是失敗 (等學到例外 exception 的機制以後就會有更容易的方法來處理這種狀況)
  
• 這四個函式不完全是獨立的, 例如 subtract 應該可以運用 add 完成, divide 應該可以運用 multiply 以及額外的 double 除法完成 (如果你把它看成是獨立的功能, 你的程式裡面就有一些重複的片段, 有重複就很容易造成維護的問題)
  
• 最後, 這幾個運算都是提供給 Complex 模組以外的程式裡用來操作 Complex 類別物件的方法, 所以應該是 public 的

做好上面的選擇後, 你還是有兩種方法來增加這些成員函式 (member function),

1. 直接編輯 Complex.h 檔案在 public 區段加入這四個函式的宣告
   
2. 在 類別檢視 中用右鍵選擇 加入/加入函式, 在 傳回型別 欄位填入函式的回傳值型態, 例如 void, 在 函式名稱 欄位中填入函式的名稱 (例如: setValue), 在 參數型別 欄位中填入參數的型態定義 (例如: double), 在 參數名稱 欄位中填入參數的名稱 (例如: real), 點選加入按鈕, 在 存取 欄位中選擇 public, 代表是公開的界面函式, Static, Virtual, Pure 和 Inline 目前都不要選, 最後按下 完成 按鈕 (將來會解釋它們的用途)。

    Complex x1, x2, x3;
    x1.setValue(7, 3);
    x2.setValue(1, 1);
    x3.setValue(5, -2); // (7+3i)/(1+i) = (5-2i)
    assert(x1.divide(x2));
    assert(x1.equal(x3, 1e-10)); // C/C++ 常數 1e-10 代表 1x10-10
    x2.setValue(0, 0);
    assert(!x1.divide(x2));

用類別來控制存取權限有兩種原因：

1. 是因為成員函式是同一個類別的所有物件共享的, 如果編譯器讓成員函式可以存取類別裡所有的私有資料成員的話, 那麼就沒有辦法區分接受訊息的物件或是其它的物件, 程式設計者可以寫出 a.add(b) 的程式, 也可以寫出 a.add(a) 的程式, 或者說實現「靜態型別(static type)系統」的程式語言是只能用類別來控制存取權限的。
   
2. 第二個原因是存取權限是用來實作封裝的機制, 封裝一個類別的物件是為了避免其它類別的物件 (或是其它程式模組) 暴力直接修改這個類別物件的私有資料或是狀態, 從這個角度看的話，用類別來控制就足夠了, 不需要用物件來控制存取權限, 撰寫程式時是用類別來分工的, 某一個人負責某幾個類別, 而不是某一個人負責幾個物件。以物件來限制存取權限, 比較偏向資訊安全的考量, 而不是軟體工程的考量。

學長姊們的痛苦經驗 1, 2

    double x = 3.1, y = .03;
    ...
    if (x+y == 3.13)
        cout << "x+y == 3.13\n";
    ...

    double x = 3.09;
    x = x/2.0 + 1.51;
    if (x == 3.055)
        cout << "x == 3.055\n";

你覺得螢幕上會列印任何東西嗎? 如果不會的話, 原因是什麼? 你可以列印一下 x 的內容, 又會發現看起來上面這個 x == 3.055 好像應該是對的, 那麼為什麼沒有印出東西來呢? 真的不是機器不好, 這和上面所說浮點數的表示方法有密切關係 :)

再多看一個程式 floatingComparison.cpp

接下來寫一個簡單的測試程式讓你看一下兩個 double 變數 (各 8 個位元組) 的實際內容: 範例程式專案, 你可以注意到 a 和 b 兩個變數的內容其實只有差最後一個位元 (70 vs. 71), 另外也請你注意一個位元組一個位元組比較的結果和直接 a == b 的結果是一樣的

在我們的程式中, 你可以用 subtract() 和 magnitude() 來檢查 "你的答案" 和 "你預期的答案" 的差異是不是小於一個很小的誤差值, 例如 1e-7 (這個數字就是 0.0000001); 第二種方法是直接檢查兩個數字的實數部份的誤差以及虛數部份的誤差是不是都小於 1e-7 (嚴格來說對於浮點數來說, 相對誤差會比絕對誤差要有意義)

所以你的 equal() 函式應該要接受兩個參數, 第一個參數是要比較的數字, 第二個參數則是可以容忍的誤差值

現在你應該要完成計算複數大小的成員函式了, 叫它 magnitude 吧, 函式應該要傳回一 double 的結果

在製作這個函式時你可能需要 C 標準函式庫中的 sqrt() 函式, 記得 #include <cmath>

接下來我們為了能夠在螢幕上顯示一個 Complex 物件的內容, 需要替這個類別加上一個 print() 的 public 成員函式, 任何時候只要呼叫 print() 就可以在螢幕 (cout) 上印出 a + b i 格式的資料

請注意我們想要列印一個複數, 可是選擇不要替 Complex 類別加上 getReal() 和 getImaginary() 的 accessor, 而是加上 print() 介面, 理由是在設計物件化的程式時我們需要 "盡力去維護類別的封裝", 通常 accessor 是偷懶的設計, 給了accessor 之後, 任意其他類別都可以直接看到這個物件裡私有的資料, 顯然不只可以完成列印的功能, 還可以完成很多很多其他的功能, 雖然比起直接把資料成員設為 public 好, 但是這樣的封裝是有名無實的, 比較起來算是失敗的

如果你考量到也許有些程式裡需要把 Complex 物件輸出到檔案串流裡, 你也可以把介面設計成 print(ostream& out), 測試時就把全域的螢幕串流物件 cout 傳遞進去

請注意: 簡單的列印程式碼在印虛數部份時會出現 1 + -2 i, 2 - 0 i, 3 + 1 i 這樣的情況, 要印得比較漂亮需要增加一些額外的處理, 不過我們重點不在這裡就不特別要求了; 另外列印時對於浮點數來說 setprecision(5) 並不是小數以後 5 位數, 而是由最高為開始有 5 位有效數字, 所以想要印到小數點右邊第五位, 需要設為定點小數 fixed, 用欄位的寬度來控制..., 其實運用 iostream 時我不知道有沒有很簡單的方式可以作出和 stdio 的 %10.5f 一樣的效果, 目前我只會在 print() 裡面把資料乘以 100000, 四捨五入, 自己印整數部份、小數部份和小數點, 否則 0.000123456 和 123.456789 好像沒辦法很簡單地都印成 0.00012 和 123.45679 (這也許要怪 stdio 怎麼會設計出像是 %10.5f 這種比較偏向絕對精確度的格式的呢?)

此時我們可以把前面放在 main() 中的所有的類別功能測試的程式碼, 集合起來到一個 unitTest() 的成員函式內, 這樣子的函式是物件導向程式作 "架構調整 (refactoring)" 時很重要的憑據, 有了 unitTest() 之後你才可以放心地修改你自己的程式, 不用擔心把原先已經測試過的程式改成錯的了, 這也是你寫的程式模組的品質管理的最基本方法。

然後你可以在 main() 中呼叫這個 unitTest() 的函式來執行單元測試

可是這個時後如果我們把 unitTest() 定義為一個成員函式, 你會發現在 main() 函式中你需要寫

Complex dummy;
dummy.unitTest();

才能夠呼叫 unitTest() 這個成員函式, 可是呼叫 unitTest 時並不是想要傳遞什麼訊息給 dummy 物件, 上面這樣子用起來不太合理; 如果你使用 static 保留字來宣告 unitTest(), 也就是用下列的語法來宣告:

class Complex 
{
...
public:
    static void unitTest();
...
}; 

現在我們應該要在 main() 函式裡寫一個比較實際的應用程式, 請由鍵盤輸入一個二元一次方程式 a x² + b x + c = 0 的實數係數 a, b, c, 請利用公式:
x₁=(-b+sqrt(b²-4ac))/(2a), x₂=(-b-sqrt(b²-4ac))/(2a), 求出 x 的兩個根 (可能是實數也可能是複數), 並且列印出來, 接著請計算

((x₁)⁵ + (x₂)⁵) / ((x₂)¹⁰ - (x₁)⁷)

        Complex x;
        x.setValue(10, 20);
        Complex y = x;   // copy constructor 拷貝建構元
        Complex z;
        z = x;            // assignment operator 設定運算子

1. 運用 CppUnit 範例與說明
2. 運用 Google C++ Testing Framework (Google Test) 範例與說明
3. 運用微軟 CppUnitTestFramework 範例與說明
4. C++ 標準函式庫 complex 類別