技術メモ (ソフトウェア開発) > その他のプログラミングメモ >

C++でMaybeモナド (boost::optional)

(2009.1.3)

C++ で Haskell の Maybeモナドっぽいものを書いてみます。

元ネタはこちら。

元ネタはHaskellっぽくJustとNothingを定義していますが、このページでは、意味が近いboost::optionalを活用してみます。

HaskellのMaybeモナド

HaskellのMaybeモナドは失敗するかもしれない値です。また、>>= 演算子でMaybeモナドを返す関数を繋いでいき、途中で失敗したら以降の関数は実行させないようにできます。

  • All About Monads モナドのすべて Haskell におけるモナドプログラミングの理論と実践に関する包括的ガイド

MaybeモナドはPreludeで次のように定義されます。

  1. data Maybe a = Nothing | Just a deriving (Eq, Ord, Read, Show)
  3. instance Monad Maybe where
  4. (Just x) >>= k = k x
  5. Nothing >>= k = Nothing
  6. return = Just
  7. fail s = Nothing

>>= の左辺の値がNothingのときは右側の関数が評価（実行）されません。

典型的な使い方は、実行時（コンパイル時ではなく）の値の探索です。lookup関数を使います。

  1. lookup :: (Eq a) => a -> [(a,b)] -> Maybe b
  2. lookup key [] = Nothing
  3. lookup key ((x,y):xys)
  4. | key == x = Just y
  5. | otherwise = lookup key xys

例えば、次の例で、

  1. config :: [(String, [(String, String)])]
  2. config = [
  3. ("path", [("tmp", "/tmp"), ("data", "/foo")]),
  4. ("user", [("u1", "hoge")])
  5. ]
  7. tmpdir :: Maybe String
  8. tmpdir = case (lookup "path" config) of
  9. Just entries -> lookup "tmp" entries
  10. Nothing -> Nothing
  12. main = print $ tmpdir

関数tmpdirを次のように書けます。

  1. tmpdir = lookup "path" config >>= lookup "tmp"

C++のboost::optional

boostのoptionalクラスはHaskellのMaybeモナドのような機能を提供します。

boostがインストールされていれば、<boost/optional.hpp>ヘッダを取り込むだけで使えます。

値が有効なときは、boost::optional<値の型>(値) でオブジェクトを生成し、無効の場合は boost::optional<値の型>() でoptionalオブジェクトを生成します。

optional には operator bool が定義されており、if文などで値が有効かどうか判定できます。

また、operator *と-> が定義されており、これらの演算子で値を取り出せます。

  1. #include <cmath>
  2. #include <iostream>
  3. #include <boost/optional.hpp>
  4. using namespace std;
  6. // 平方根
  7. boost::optional<double> my_sqrt(double x) {
  8. if (x < 0)
  9. return boost::optional<double>(); // 不正
  10. else
  11. return boost::optional<double>(sqrt(x));
  12. }
  14. int main() {
  15. boost::optional<double> y = my_sqrt(150.0);
  16. if (y)
  17. cout << *y << endl;
  18. else
  19. cout << "error.\n";
  20. return 0;
  21. }

optionalに渡す型は、デフォルトコンストラクタはなくても構いませんが、（暗黙にでも）コピーコンストラクタを持たなければなりません。

C++でMaybeモナド

>>=演算子とlookupを書いてみます。

Haskellでは2引数の関数に一つだけ実引数を与えると1引数の関数が得られます（関数の部分適用）が、C++ではそういうわけにはいきません。

MkLookupクラスを作って、>>=が渡すはずの一つの引数以外はコンストラクタで与えるようにします。

で、1回目。lookup のキーは整数限定です。

  1. #include <vector>
  2. #include <string>
  3. #include <utility>
  4. #include <cstdio>
  5. #include <boost/optional.hpp>
  6. using namespace std;
  8. template <typename ContainerType, typename ValueType>
  9. boost::optional<ValueType> lookup(const ContainerType& kv, int k) {
  10. typename ContainerType::const_iterator i;
  11. for (i = kv.begin(); i != kv.end(); i++) {
  12. if (i->first == k)
  13. return boost::optional<ValueType>(i->second);
  14. }
  15. return boost::optional<ValueType>();
  16. }
  18. template <typename ContainerType, typename ValueType>
  19. struct MkLookup: public unary_function<ValueType, boost::optional<ValueType> > {
  20. int const key;
  21. MkLookup(int k): key(k) {}
  22. boost::optional<ValueType> operator () (const ContainerType& c) const {
  23. return lookup<ContainerType, ValueType>(c, key);
  24. }
  25. };
  27. template <typename ContainerType, typename ValueType>
  28. boost::optional<ValueType>
  29. operator >>= (const boost::optional<ContainerType>& maybe_x,
  30. const MkLookup<ContainerType, ValueType>& f) {
  31. if (maybe_x)
  32. return f(*maybe_x);
  33. else
  34. return boost::optional<ValueType>();
  35. }
  37. typedef pair<int, string> KV;
  38. typedef pair<int, vector<KV> > Db;
  40. int main() {
  41. vector<Db> db;
  42. vector<KV> v1;
  43. v1.push_back(KV(10, "foo"));
  44. v1.push_back(KV(20, "bar"));
  45. db.push_back(Db(1, v1));
  47. v1.clear();
  48. v1.push_back(KV(2, "hoge"));
  49. v1.push_back(KV(3, "hogehoge"));
  50. db.push_back(Db(50, v1));
  52. // 以下のコードを何とかしたい
  53. boost::optional<vector<KV> > x = lookup<vector<Db>, vector<KV> >(db, 1);
  54. if (x) {
  55. boost::optional<string> y = lookup<vector<KV>, string>(*x, 10);
  56. if (y)
  57. printf("v = %s\n", y->c_str());
  58. else
  59. printf("v = Nothing\n");
  60. }
  61. else
  62. printf("v = Nothing\n");
  64. // こんな感じ？
  65. boost::optional<string> y = (lookup<vector<Db>, vector<KV> >(db, 1)
  66. >>= MkLookup<vector<KV>, string>(10));
  67. if (y)
  68. printf("v = %s\n", y->c_str());
  69. else
  70. printf("Nothing\n");
  72. return 0;
  73. }

pairとvectorを使いましたが、もっとC++っぽくと思うと、lookup はmapかmultimapを使う方がいいような気がします。

あと、型推論がないと、型をいたるところで書かないといけなくて大変です。

std::mapを使う

(2009.1.15) この節を追加。

2回目は、std::map あるいは tr1::unordered_mapを受け付けるようにしてみました。キーも自由に選べます。>>= の右辺がMkLookupに依存していたのも止めました。

  1. #include <string>
  2. #include <cstdio>
  3. #include <map>
  4. #include <tr1/unordered_map>
  5. #include <boost/optional.hpp>
  6. using namespace std;
  7. using namespace tr1;
  8. using namespace boost;
  10. /** コンテナからキーに対応する値を探す. 関数版.
  11. Container は、key_type と mapped_type 型, find() 関数を持つこと. */
  12. template <typename Container>
  13. optional<typename Container::mapped_type>
  14. lookup(const Container& kv, const typename Container::key_type& key) {
  15. typename Container::const_iterator p = kv.find(key);
  16. if (p != kv.end())
  17. return optional<typename Container::mapped_type>(p->second);
  18. else
  19. return optional<typename Container::mapped_type>();
  20. }
  22. /** 1引数の関数のようにする. */
  23. template <typename Container>
  24. struct MkLookup {
  25. typename Container::key_type const key;
  26. MkLookup(const typename Container::key_type& k): key(k) {}
  28. optional<typename Container::mapped_type>
  29. operator () (const Container& c) const {
  30. return lookup<Container>(c, key);
  31. }
  32. };
  34. /** 左辺が成功したときだけ右辺を評価.
  35. 右辺の関数はContainerオブジェクトを引数に取る. */
  36. template <typename Container, typename F>
  37. optional<typename Container::mapped_type>
  38. operator >>= (const optional<Container>& maybe_x, const F& f) {
  39. if (maybe_x)
  40. return f(*maybe_x);
  41. else
  42. return optional<typename Container::mapped_type>();
  43. }
  45. void put_optional(const optional<string>& x) {
  46. if (x)
  47. printf("value = \"%s\"\n", x->c_str());
  48. else
  49. printf("value = Nothing\n");
  50. }
  52. typedef map<int, string> L2;
  53. typedef tr1::unordered_map<int, L2> L1;
  55. int main() {
  56. L1 db;
  57. L2 v1;
  58. v1.insert(pair<int, string>(10, "foo"));
  59. v1.insert(pair<int, string>(20, "bar"));
  60. db.insert(pair<int, L2>(1, v1));
  62. v1.clear();
  63. v1.insert(pair<int, string>(2, "hoge"));
  64. v1.insert(pair<int, string>(3, "hogehoge"));
  65. db.insert(pair<int, L2>(50, v1));
  67. // 以下のコードを何とかしたい
  68. optional<L2> x = lookup<L1>(db, 1);
  69. if (x) {
  70. optional<string> y = lookup<L2>(*x, 10);
  71. put_optional(y);
  72. }
  73. else
  74. printf("v = Nothing\n");
  76. // こんな感じ？
  77. optional<string> y = lookup<L1>(db, 50) >>= MkLookup<L2>(2);
  78. put_optional(y);
  80. // 左辺がNothingのとき
  81. optional<string> z = lookup<L1>(db, 11) >>= MkLookup<L2>(2);
  82. put_optional(z);
  84. return 0;
  85. }

>>= の使い方がずいぶんすっきりしました。

サイト内関連ページ

はすけるで遊ぶ
Haskellのメモがいくつか。

外部リンク

C++でMaybeモナドを返すlookup関数を作ってみた - Faith and Brave - C++で遊ぼう
こちらのほうが高度です。
C++ for Haskeller
ネタ。