レポート課題：演算子オーバーロードを用いた文字列クラスの実装・テスト

訂正

配布したWordテンプレートにおいて、以下の誤りがありましたので訂正します。
表紙・チェック項目
誤）メンバ演算子関数で+演算子による文字列の連結演算子が実装されているか？
正）フレンド演算子関数で+演算子による文字列の連結演算子が実装されているか？
（2015/6/8再度修正　正・誤が入れ替わっていました。レポート課題としては、内容として矛盾が無ければどちらでもOKとします。申し訳ありません。大川）

課題

課題１－５(中級編1週目)で作成したプロジェクトp3kadai2w1をベースとして、表１の機能を持つ文字列クラス(MyString)を作成しテストしなさい。

必須課題

表１の必須機能を持つ文字列クラス(class MyString)の設計【機能仕様の作成】
表１の必須機能の実装【実装仕様の作成、実装】
表１の必須機能のテスト【検証仕様の作成、テスト】
考察課題（手書き）: 必須課題で実装した文字列連結演算子(+)の動作を図示した上で、文章で解説しなさい。図には、文字列データのメモリ上の配置を示すこと。

オプション課題

表１のオプション機能の設計【機能仕様の作成】
表１のオプション機能の実装【実装仕様の作成、実装】
表１のオプション機能のテスト【検証仕様の作成、テスト】
入力ファイルから英語の文章を入力し、空白文字で区切られた単語ごとに、辞書式順序でソート処理を行うC++プログラム(SortMyStringクラス)の実装・テスト
- 入力例： The quick brown fox jumps over the lazy dog
- 出力例： The brown dog fox jumps lazy over quick the
- MyStringクラスを用いて、オブジェクト同士の比較を行う事で、ソート処理を行う事。
- プログラムは、SortMyStringクラスとして作成せよ。（ファイル名：SortMyString.cpp, SortMyString.h）
辞書式順序でソートする際の性能を、C言語での実装や各種ソートアルゴリズムと比較・考察

注意点

電子ファイル版レポートは、Wordテンプレートを元に作成し、必要に応じてExcelから図表をコピーすること。最終的にはPDFに変換して提出すること。
手書き版レポートは、PDFファイルに手書きで記入し作成すること。
参考として機能仕様・実装仕様・検証仕様・テスト結果のサンプルを示す。これを参考して完全なものにして提出する事。
また、テスト環境はmain.cpp、TestMyString.hおよびTestMyString.cppを使用して良い。テストプログラムは、一部を除き実装されていないので、各自必要な部分を実装すること。
テストメソッドの戻り値は、結果が期待値と同じ場合に、TEST_OKとし、違う場合にTEST_NGとする。テスト対象の戻り値がTrueだからTEST_OK、FalseだからTEST_NGとするわけではない。(2015/6/8追記　大川)
テストの際にprintStringメソッドおよびgetConstCharArrayメソッドはオブジェクトの状態を観測するためのデバッグ用メソッドと位置づけ、printStringメソッドおよびgetConstCharArrayメソッド自体のテストは除外してよい。
テストの際にMyStringオブジェクトをconstオブジェクトとして扱うこととし、MyStingオブジェクトが保持している文字列の内容確認に用いるgetConstCharArrayメソッドは、constメソッドである必要がある。最新のソースファイルを参考に。MyString.h, MyString.cpp

表1　MyStringクラスの機能

機能	例	備考	必須機能かどうか
オブジェクトの生成が可能であること	MyString str1, str2; before: str1=存在しない, str2=存在しない after: str1="", str2=""	デフォルトコンストラクタを作成せよ実装済	必須
char配列文字列をもとにしたオブジェクトの生成が可能であること	MyString str1("Foo"); before: str1=存在しない after: str1="Foo"	引数をもつコンストラクタを作成せよ実装済	必須
オブジェクトのコピーが可能であること	MyString str1 (str2); before: str1=null, str2="Foo" after: str1="Foo", str2="Foo"	コピーコンストラクタを作成せよ実装済	必須
標準出力に文字列を出力できること (デバッグ用観測メソッド）	str1.printString(); before: str1="hoge" after: str1="hoge", コンソール出力="hoge"	printStringメソッドを作成せよ実装済	必須
char配列文字列へ読み取り専用ポインタを取得可能であること (デバッグ用観測メソッド）	*const char ca = str.getConstCharArray();** before: str="hoge" after: str1="hoge", ca="hoge"	getConstCharArrayメソッドを作成せよ実装済	必須
任意の文字への参照を返す機能を持つこと	str1.getChar(2) = 'G'; before: str1="hoge" after: str1="hoGe"	getCharメソッドを作成せよ実装済	必須
機能	例	備考	必須機能かどうか
==演算子による文字列の一致判定が可能であること	bool result = str1 == str2; before: str1="123", str2="456" after: result=false str1="123", str2="456"	メンバ演算子関数で作成せよ引数はconst参照とすること	必須
＝演算子によりMyStringクラス文字列オブジェクトの代入が可能であること	str1 = str2; before: str1="hoge", str2="Foo" after: str1="Foo", str2="Foo"	メンバ演算子関数で作成せよ引数はconst参照とすること	必須
＋演算子によりMyStringクラス文字列オブジェクト同士の連結が可能であること	str1 = str2 + str3; before: str1="hoge", str2="Foo", str3="Bar" after: str1="FooBar", str2="Foo", str3="Bar"	フレンド演算子関数で作成せよ引数はconst参照とすること	必須
機能	例	備考	必須機能かどうか
<演算子による文字列の辞書順比較が可能であること	bool result = str1 < str2; before: str1="123", str2="456" after: result=true str1="123", str2="456"	メンバ演算子関数で作成せよ引数はconst参照とすること	オプション
>演算子による文字列の辞書順比較が可能であること	bool result = str1 > str2; before: str1="123", str2="456" after: result=false str1="123", str2="456"	メンバ演算子関数で作成せよ引数はconst参照とすること	オプション
<< ストリーム出力演算子による標準出力への出力が可能であること	cout << str1; before: str1="hoge" after: str1="hoge", コンソール出力="hoge"	フレンド演算子関数で作成せよ引数はconst参照とすること	オプション
>> ストリーム入力演算子による標準入力からの入力が可能であること	cin >> str1; before: コンソール入力="hoge", str1="" after: str1="hoge"	フレンド演算子関数で作成せよ引数は参照とすること	オプション

課題の補足説明

実装のヒント

"abc" == "ABC" ?

文字列の一致比較には関数strcmp を使うとよい。
関数strcmpを使うには<cstring>または<string.h>をインクルードする必要がある。

"hoge" + "Foo" = ?

文字列の連結には関数strcat を使うとよい。予めメモリ領域を確保しておく必要があることに注意。
関数strcatを使うには<cstring>または<string.h>をインクルードする必要がある。

レポートに掲載する結果とは

テスト項目表と、テスト結果のPASS/FAIL
テストプログラムについてデバッガ上で実行し、メモリリークが発生しないことを確認した結果
オプション課題まで作成した場合は、その結果

なお、メモリリークが発生せずに動作していることを以下のメイン関数を用いて確認すること。

メイン関数　(main.cpp)

また、入力された文字列をメンバ変数にセットする関数は以下のようにかけるので、参考にすると良い。

テスト環境のソースコードを以下に示す。

課題の意義

クラスの設計とは

【機能仕様】機能を満たすために必要な、クラスのメンバ（メソッド＝関数・フィールド＝変数）をリストアップする
【機能仕様】フィールドの型を決め命名する。それぞれについて、役割を説明する一覧表にする
【機能仕様】メソッドを命名し引数、引数の型、戻り値の型を決める。それぞれについて、入力・出力・機能を説明する一覧表にする　※演算子はメソッドの一部

機能仕様を作成することにより、開発対象を明確化できる。

また、クラスを利用する人が必要な情報を整理することが出来る（マニュアルが完成）。

クラスの実装とは

【実装仕様】機能仕様を実現するために必要な実装上の注意点について検討し、クラスのメンバごとに記載する
【実装仕様】機能仕様を実現するために必要なファイルの構成について検討し、記載する
【実装】実装仕様に対応するヘッダファイルを作成しクラス宣言のC++コードを記述する
【実装】実装仕様に対応するソースファイルを作成しクラスの各メソッドのC++コードを記述する

実装仕様を作成することにより、実装の際の注意点を事前に洗い出し、実装後になってからの手戻りを減らすことが出来る。

今回は必要が無いと思われるが、メソッド内部の動作が複雑な場合は、フローチャートなどの図を用いて検討した結果を示すこともある。

クラスのテストとは

【検証仕様】テスト項目表の作成　各項目には、事前条件・入力値・期待値を明記した一覧表にする
【テスト】テスト項目表の各項目に対応するテストプログラムの作成　（１項目＝１関数とし、入力に対する出力を期待値と比較し結果を返す）
【テスト】テストプログラムを走らせて、テスト項目をすべて実施し、各項目のOK/NGを一覧表に記入する

検証とは、実装と仕様が一致していることを確認することである。

検証仕様（テスト項目）を作成することにより、実装するプログラムが備えるべき機能が明確になる。

テストを実施することにより、プログラムが期待通りに実装できている事を確認できる。