# 自作の数値クラスで演算をムーブに対応する方法
自作の数値計算をするクラスを実装するとしよう。無限精度整数、ベクトル、行列など、自作のクラスで実装したい数値と演算は世の中にたくさんある。
そのとき、数値の状態を表現するためにストレージを動的確保するとしよう。ここでは例のため、とても簡単な整数型を考える。
class Integer
{
int * ptr ;
} ;
# 基本の実装
まずは基本となるコンストラクターとデストラクター、コピー、ムーブを実装しよう。
struct Integer
{
int * ptr ;
public :
explicit Integer( int value = 0 )
: ptr ( new int(value) ) { }
~Integer( )
{ delete ptr ; }
// コピー
Integer( const Integer & r )
: ptr( new int( *r.ptr ) ) { }
Integer & operator = ( const Integer & r )
{
if ( this != &r )
*ptr = *r.ptr ;
return *this ;
}
// ムーブ
Integer( Integer && r )
: ptr( r.ptr )
{ r.ptr = nullptr ; }
Integer operator =( Integer && r )
{
delete ptr ;
ptr = r.ptr ;
r.ptr = nullptr ;
return *this ;
}
} ;
コンストラクターは動的確保をする。デストラクターは解放する。コピーは動的確保をする。ムーブは所有権の移動をする。とてもよくあるクラスの実装だ。
実用的にはstd::unique_ptr<int>を使うべきだが、低級な処理を説明するためにあえて生のポインターを使っている。
今回のコピー代入演算子は単に値をコピーしているが、コピー元とコピー先で確保したストレージのサイズが異なるような型、たとえば無限精度整数や動的なサイズのベクトルや行列などの場合は、コピー代入演算子でもコピー先のストレージを破棄してコピー元と同じサイズのストレージを確保するなどの処理が必要な場合もある。
// 行列クラス
class matrix
{
// オブジェクトごとにサイズが異なる
unique_ptr<double> ptr ;
std::size_t rows ;
std::size_t columns ;
public :
// コピー代入演算子
matrix & operator = ( const matrix & r )
{
// 自分自身への代入
if ( this == &r )
return *this ;
// 行列のサイズが同じかどうか確認
if ( rows == r.rows && columns == r.columns )
{
// コピー元の行列の値をコピー先にコピー
// コピー先のストレージはそのまま使える
}
else
{
// コピー先のストレージを解放
// コピー先はコピー元の行列サイズと同じストレージを確保
// 値をコピー
}
}
} ;
# 複合代入演算子
複合代入演算子というのは、operator +=やoperator -=のような演算子だ。これはコピー代入演算子と同じように実装できる。違いは代入の結果、演算をするだけだ。
クラスIntegerの場合、演算の結果ストレージのサイズが変わるということはないので、愚直な実装で済む。
Integer & operator +=( const Integer & r )
{
*ptr += *r.ptr ;
return *this ;
}
Integer & operator -=( const Integer & r )
{
*ptr -= *r.ptr ;
return *this ;
}
複合代入演算子をムーブ代入演算子として実装する理由は、通常はない。
# 単項演算子
演算を表現するクラスでオーバーロードしたい単項演算子にはoperator +とoperator -がある。特にoperator -は実用上の意味があるので実装してみよう。
Integer a(10) ;
auto b = -a ;
// これは二項演算子 operator +の結果に
// 単項演算子operator -を適用
auto c = -(a + a) ;
*thisがlvalueの場合の単項演算子の実装は以下のようになる。
Integer operator -() const
{
Integer result( -*ptr ) ;
return result ;
}
// operator +()の実装は省略
単項演算子operator -は*thisを書き換えない。負数にした値のコピーを返す。
変数resultはreturn文のあとは使われないので、return std::move(result) と書くこともできる。しかし、そのように書く必要はない。というのもreturn文は特別な扱いを受けているので、関数の中の変数をreturnした場合、自動でムーブが行われるからだ。もちろん、std::moveを明示的に書いてもよい。
単項演算子operator -は*thisがlvalueのときには上のように実装するしかない。しかしこの実装は非効率的だ。なぜならば、コードを読めばわかるように、追加の一時変数が生成され、追加の動的メモリー確保が行われるからだ。
そのため、もしクラスIntegerがコピーしか実装していない場合、
Integer a ;
auto b = -a ;
というコードは、
Integer a ;
auto b = a ;
b.make_it_negative() ;
のような現在の値をそのまま負数にするメンバー関数make_it_negativeを実装して使った方が効率がよくなる。
class Integer
{
int * ptr ;
public :
void make_it_negative()
{
*ptr = -*ptr ;
}
} ;
幸い、クラスIntegerはムーブコンストラクターを実装しているので、
auto b = -a ;
というコードは、式-aによって生成された一時オブジェクトが変数bにムーブされる。
しかし、
auto c = -(a + a) ;
というコードは依然として非効率的になる。まだ二項演算子operator +は実装していないが、これは、
auto temp1 = a + a ;
auto temp2 = -temp1 ;
auto c = temp2 ;
になるからだ。すると以下のように書いた方が効率がよくなる。
Integer a ;
auto c = a ;
c += a ;
c.make_it_negative() ;
こんなコードを書くのは面倒だ。単に-(a+a)と書いて効率的に動いてほしい。そのために単項演算子operator -をムーブに対応させる。
単項演算子はクラスのメンバー関数として実装する。
class Integer
{
public ;
Integer operator -() const ;
} ;
これが非メンバー関数ならば、単にrvalueリファレンスを取ればよい。
Integer negate( Integer && object ) ;
メンバー関数の場合、objectに相当するのは*thisだ。
class Integer
{
public :
// *thisがobjectに相当する
Integer negate() ;
} ;
thisがポインターになっているのは歴史的な都合で、本来はリファレンスになっているべきだった。メンバー関数は以下のような隠し引数があるものとして考えるとよい。
class Integer
{
public :
// 隠し引数
Integer negate( Integer & THIS )
{
Integer * this = &THIS ;
}
} ;
もちろん、このような隠し引数THISをC++のプログラムから参照する方法はない。あくまでも参考のためのコードだ。
メンバー関数をconst修飾するというのは、
class Integer
{
public :
Integer negate() const ;
} ;
この隠し引数をconst修飾するのと同じだ。
class Integer
{
public :
Integer negate( const Integer & THIS )
{
const Integer * this = &THIS ;
// ...
}
} ;
これによってconst修飾の有無でメンバー関数を呼び分けられる。
struct X
{
void f() ;
void f() const ;
} ;
int main()
{
X x ;
x.f() ; // 非const
const X & cx = x ;
cx.f() ; // const
}
C++にはconst修飾と同様に、「リファレンス修飾」という機能がある。これを使えば隠し引数にlvalue/rvalueリファレンスの修飾ができる。
struct X
{
// lvalueリファレンス修飾子
void f() & ;
// rvalueリファレンス修飾子
void f() && ;
} ;
int main()
{
X lvalue ;
// lvalueリファレンス
lvalue.f() ;
// rvalueリファレンス
std::move(lvalue).f() ;
}
これは実質的以下のような隠し引数があるものと考えてよい。もちろん隠し引数を使うことはできない。
struct X
{
// lvalueリファレンス
void f( X & THIS )
{
X * this = &THIS ;
}
void f( X && THIS )
{
X * this = &THIS ;
}
} ;
void f() &&のメンバー関数の中では、*thisはlvalueだ。rvalueリファレンスの変数はlvalueであることを思い出そう。
void f( int & ) ;
void f( int && ) ;
int main()
{
int lvalue {} ;
int && rvalue = std::move(lvalue) ;
// int &を呼び出す
// rvalueリファレンスの変数はlvalue
f( rvalue ) ;
}
クラスでメンバー関数にリファレンス修飾子を書かなかった場合、lvalueリファレンス修飾子を書いたものとみなされる。
struct X
{
// lvalueリファレンス
void f() ;
} ;
もしメンバー関数にリファレンス修飾子を書いた場合、同じ名前のすべてのメンバー関数にリファレンス修飾子を書かなければならない。
struct X
{
// エラー、リファレンス修飾子がない
void f() ;
void f() & ;
// OK、リファレンス修飾子がある
void g() & ;
void g() && ;
// OK リファレンス修飾子を使っていない
// デフォルトでlvalueリファレンス修飾子
void h() ;
} ;
リファレンス修飾子を使い、*thisがlvalueとrvalueの場合で実装を分けることができる。
class Integer
{
int * ptr ;
public :
// lvalue版
Integer operator -() const &
{
auto result = ( -*ptr ) ;
return result ;
}
// rvalue版
Integer operator -() &&
{
auto result = std::move(*this) ;
*result.ptr = -*result.ptr ;
return result ;
}
} ;
rvalueリファレンス修飾子を使った単項演算子operator -の実装は、*this自身がrvalueであるので、自分自身をムーブしている。ムーブ以降、this->ptrはnullptrになる。なぜならば、Integerのムーブ代入演算子がそのような実装になっているからだ。
/// 上で示したのと同じムーブ代入演算子の抜粋
Integer operator =( Integer && r )
{
delete ptr ;
ptr = r.ptr ;
// ムーブ元のポインターをnullptrにする
r.ptr = nullptr ;
return *this ;
}
# 二項演算子
せっかく数値を表現するクラスなのだから二項演算子を使った演算がしたい。
int main()
{
Integer a(1) ;
Integer b(2) ;
Integer c = a + b ;
}
これをどうやって実装するのかというと、operator +演算子のオーバーロードで実装する。
演算子のオーバーロードはメンバー関数による方法と、非メンバー関数による方法がある。
struct X
{
// メンバー関数
X operator +( const X & r ) ;
} ;
// 非メンバー関数
X operator +( const X & l, const X & r ) ;
operator =のような特殊な演算子以外は、どちらの方法で書いてもいい。メンバー関数として書いた場合、第一引数は*thisに、第二引数が関数の引数rになる。
例えば以下のようなコードで、
X a ;
X b ;
a + b ;
メンバー関数の場合、*thisはa、rはbになる。
非メンバー関数の場合、lはaは、rはbになる。
# ムーブしない実装
二項演算子のオペランドがどちらもlvalueであった場合はムーブができないので、引数はconstなlvalueリファレンスで受け取り、prvalueを返す。
メンバー関数の場合の実装は以下のようになる。
class Integer
{
int * ptr ;
public :
// 省略...
Integer operator +( const Integer & r ) const
{ return Integer( *ptr + *r.ptr ) ; }
} ;
非メンバー関数の場合は、Integer::ptrがprivateメンバーであることが問題になる。
Integer operator + ( const Integer & l, const Integer & r )
{
// エラー、Integer::ptrはprivateメンバー
return Integer( *l.ptr + *r.ptr ) ;
}
これを解決するための方法はいくつかある。
- クラスのメンバー関数として処理を実装し、そのメンバー関数を呼び出す方法
class Integer
{
int * ptr ;
public :
Integer plus( const Integer & r ) const
{ return Integer( *ptr + r.ptr ) ; }
} ;
Integer operator + ( const Integer & l, const Integer & r )
{
return l.plus( r ) ;
}
- friend宣言する方法
クラスが別のクラスや関数をfriend宣言すると、その関数はクラスのprivateなメンバーを使えるようになる。
class X
{
int member ;
// friend宣言
friend int get_member( const X & ) ;
} ;
int get_member( const X & obj )
{
// OK、friendなので使える
return obj.member ;
}
これを使うと、以下のようにfriend宣言すれば、動かなかった非メンバー関数によるoperator +のオーバーロードが動くようになる。
class Integer
{
friend Integer operator +( const Integer &, const Integer & ) ;
} ;
# ムーブをしたくなる状況
上の二項演算子の実装だけで、クラスIntegerは加算ができるようになった。ただし、効率がよくない。
例えば以下のようなコードを考えよう。
Integer a ;
auto b = a + a + a ;
これはどのように評価されるかというと、a+a+aは、(a+a)+aとなり、(a+a)を評価した結果の一時オブジェクトが生成され、その一時オブジェクトを仮にtempと呼ぶと、temp+aされる。
結果として、以下のようなコードと同じになる。
Integer a ;
auto temp = a + a ;
auto b = temp + a ;
ムーブを実装していない場合、以下のように書いた方が効率がよくなる。
Integer a ;
auto b = a ;
b += a ;
b += a ;
このようなコードは面倒だ。できればa + a + aと書きたい。
二項演算子はoperator +だけではない。
auto result = a + b - c * d / e ;
のようなコードも書きたい。これを効率化のために、
auto result = a;
a += b ;
auto temp = c ;
temp *= d ;
temp /= e ;
result -= temp ;
のように書かなければならないとしたら悲惨だ。
a+a+aのような式が効率的に動くためには、二項演算子でlvalue/rvalueリファレンスを取り、rvalueリファレンスの場合はムーブするコードを書く。rvalueからは所有権を横取りしてもよいからだ。
二項演算子は引数が2つあり、それぞれにlvalue/rvalueがあるので、4通りのオーバーロードを書かなければならない。
非メンバー関数で実装するには、以下のように宣言を書く。
class Integer
{
friend integer operator + ( const Integer & l, const Integer & r ) ;
friend integer operator + ( Integer && l, const Integer & r ) ;
friend integer operator + ( const Integer & l, Integer && r ) ;
friend integer operator + ( Integer && l, Integer && r ) ;
} ;
// lvalue + lvalue
Integer operator + ( const Integer & l, const Integer & r ) ;
// rvalue + lvalue
Integer operator + ( Integer && l, const Integer & r ) ;
// lvalue + rvalue
Integer operator + ( const Integer & l, Integer && r ) ;
// rvalue + rvalue
Integer operator + ( Integer && l, Integer && r ) ;
具体的な実装としては、まずrvalueリファレンスで束縛したリファレンスを関数のローカル変数にムーブしたあとで、その変数をreturnする。
第一引数がrvalueの場合は、以下のようになる。
Integer operator + ( Integer && l, const Integer & r )
{
auto result = std::move(l) ;
result += r ;
return result ;
}
第一引数はrvalueなので、ムーブしてもよい。
先ほども説明したように、'return文'が関数のローカル変数を返すときは自動でムーブしてくれる。もちろん'return std::move(result)' と書いてもよい。
第二引数がrvalueの場合は、ムーブすべきオブジェクトが第二引数になる。
Integer operator + ( const Integer & l, Integer && r )
{
auto result = std::move(r) ;
result += l ;
return result ;
}
この実装はすべてに使えるわけではない。加算の場合は、一般に交換法則を満たすことが期待できる。つまり、
$$ a + b = b + a $$
であることが期待できるが、除算演算子operator /は交換法則を満たさない。今回のIntegerのような簡単な作りのクラスならば実装できるが、クラスの実装と演算次第では第二引数のみがrvalueの場合にはムーブできない場合もあるだろう。そういう場合には実装しなくてもよい。実装できないものは実装しないのが正しい。
第一引数、第二引数のいずれかがrvalueであるときにムーブする演算子のオーバーロードを両方とも実装した場合、両方の引数がrvalueである場合のオーバーロードも実装しなければならない。
第一引数、第二引数が両方共rvalueである場合というのは、例えば以下のような場合だ。
Integer a ;
auto b = (a + a) + (a + a) ;
a+aを評価した結果はrvalueだ。この式ではrvalueとrvalueをoperator +に渡しているので、引数は両方ともrvalueになる。
もし、rvalue + lvalueとlvalue + rvalueに対応する演算子しかオーバーロードしていない場合、関数呼び出しが曖昧になってしまう。そこで、rvalue + rvalueの演算子オーバーロードも書く。
Integer operator +( Integer && l, Integer && r )
{
return std::move(l) + r ;
} ;
この実装は単にrvalue + lvalueの演算子オーバーロードに実際の処理を丸投げしている。変数rはここではlvalueだ。何度も言うようにrvalueを束縛したrvalueリファレンスの変数はlvalueだ。ここでは第一引数をムーブし、第二引数はlvalueとして扱っている。
メンバー関数で実装する場合、二項演算子の第一引数は*this、第二引数がメンバー関数の第一引数になる。
class Integer
{
public :
// lvalue + lvalue
Integer operator + ( const Integer & r ) const & ;
// rvalue + lvalue
Integer operator + ( const Integer & r ) && ;
// lvalue + rvalue
Integer operator + ( Integer && r ) const & ;
// rvalue + rvalue
Integer operator + ( Integer && r ) && ;
} ;
a + bのとき、*thisがa、rがbだ。あとの実装は非メンバー関数の場合と変わらない。
例えばメンバー関数でrvalue + lvalueの実装は以下のようになる。
Integer Integer::operator +( const Integer & r ) &&
{
auto result = std::move(*this) ;
result += r ;
return result ;
}