SWAPとは、
2つの変数の値を交換するマクロや関数です。
この関数そのものはとても簡単なことなのですが、逆にそれ故に、
マクロだけで実現できないかと考える人も多く、結構話題になっています。
まず、もっとも基本的な関数による実装から説明を始めます。
2つ変数の値を変更する必要があるので、当然ポインタ型の引数を使います。
後は、関数の側で2つの変数を交換すればよいのですが、ここでの注意点は、
void swap(int* a, int* b)
{
*a = *b;
*b = *a;
return;
}
という方法では駄目だということです。
なぜなら、*aに*bを代入した時点で、*aの中身は*bの中身と同じになっているので、
そのあとで*aを*bに代入しても無意味だからです。
したがって、もう1つローカル変数を宣言し、そちらに*aを退避しておく必要があります。
次のプログラムは、もっとも
標準的なswap関数の実装例です。
#include <stdio.h>
void swap(int* a, int* b);
int main(void)
{
int a = 10, b = 100;
printf("a = %3d : b = %3d\n", a, b);
swap(&a, &b);
printf("a = %3d : b = %3d\n", a, b);
return 0;
}
void swap(int* a, int* b)
{
int temp;
temp = *a;
*a = *b;
*b = temp;
return;
}
このプログラムの実行結果は、次の通りです。
a = 10 : b = 100
a = 100 : b = 10
後は、これを型ごとに用意すれば良いだけなのですが、
C言語では、インラインやオーバーロードやテンプレートのような機能は使えませんので、
型ごとに別々の名前を付けて1つ1つ作ってやらなくてはなりません。
それでは使いにくいし、たとえC++でも、呼び出しのオーバーヘッドが気になるので、
何とか
マクロだけで実現したいという人々は結構いるようです。
まず考えられたのは、次のような加減算による実装です。
#define SWAP(a, b) (a += b, b = a - b, a -= b)
原理は簡単ですね。先にbを足しておいて、bの値を保存するやり方です。
一見すると、足し算によるオーバーフローが気になりますが、
オーバーフローした場合でも、足した分はループするので、問題なく動作するわけです。
もうひとつ、排他的論理和を利用した方法も考え出されました。
#define SWAP(a, b) (a ^= b, b = a ^ b, a ^= b)
排他的論理和のついての説明は省きますが、原理的には大差ありません。
一般に、加算や減算より排他的論理和のほうがわずかに高速なので、場合によってはこちらを使います。
ただし、実数値には使用できないので、汎用性には欠けることになります。
この2つのマクロは、ほとんどの場合には問題なく動作するのですが、
実は、うまく動作しないケースがあり、それが最大の問題となります。
それは、
同じ変数を指定した場合に起こります。
論より証拠なので、実際に試してみることにします。
#include <stdio.h>
#define SWAP(a, b) (a += b, b = a - b, a -= b)
int main(void)
{
int a = 98;
printf("a = %3d\n", a);
SWAP(a, a);
printf("a = %3d\n", a);
return 0;
}
このプログラムの実行結果は、次の通りです。
同じ変数であるaの値を交換したなら、結果は当然そのままなはずですが、
この方法では0になってしまっています。
この方法では、マクロのaとbは常に同じ値なので、引き算すれば0になるのは当然です。
ちなみに、排他的論理和による方法でもやはり0になります。
同じ変数を交換することなんてないと思うかもしれませんが、
実際には、
ソートプログラムで、array[i] と array[j] を交換する時に i == j だった、
ということはありえます。しかも、SWAPの使い道のほとんどはソートプログラムです。
この問題はどうしようもないので、一般的にはこれ以上踏み込んではいないようなのですが、
筆者はこれも無理にでも解決したくて、&&演算子による方法を使っています。
&&演算子では、直前に実行した式が偽なら、後の式は実行しない性質があります。
次のマクロは、
&&演算子の性質を利用したSWAPマクロです。
#define SWAP(a, b) ((a != b) && (a += b, b = a - b, a -= b))
このマクロでは、aとbの値が異なるときだけ、交換を実行します。
つまり、aとbが同じ変数だった場合には、交換されずにそのまま残ります。
ただ、こんなことをするよりは関数にした方が簡単だとも言えるかもしれません。
あるいは、演算子の性質に依存したくない場合は、3項演算子を使うこともできます。
#define SWAP(a, b) ((a != b) ? (a += b, b = a - b, a -= b) : 0)
後半の0は、文法のつじつま合わせのためのダミー値にすきません。
ただし、コンパイラによっては無意味な式として警告になるかもしれません。
これらのマクロであれば、どんな型(実数でも)の変数でも交換可能なのですが、
唯一、加減算のできないポインタ型の変数だけは
交換できません。
ポインタ変数を使用しない場合ならSWAPマクロを作ることができますが、
ポインタ変数の交換だけは、どうしても最初に示した関数による実装しかありません。
そして困ったことに、ソートプログラムでポインタを交換することもあるのです。
さらに、実数値を交換するときに、
ケタ落ちが起こる可能性があります。
たとえば、変数aの値がものすごく巨大で、bの値がものすごく極小だった場合、
a+bを計算しても、結果が丸められ、aと同じになってしまう可能性があります。
したがって、正確さが求められる場合には使用できません。
結局、確実に値を交換するためには、どうしても一時変数が必要になってきます。
そのためには、
マクロ内で変数を宣言する必要があります。
マクロは単なる置き換えに過ぎないので、型を指定すれば変数を宣言できます。
また、{} で囲んでブロック化すれば、変数名の衝突を避けることができます。
具体的には、次のようになります。
#define SWAP(type,a,b) { type temp = a; a = b; b = temp; }
このマクロは、初めの引数に型を指定する必要がある分、使い勝手は多少劣りますが、
型さえ指定すればどんな変数でも交換できます。
もちろん、実数値の交換やポインタ値の交換も可能です。
次のプログラムは、このマクロを使用して変数を交換する例です。
#include <stdio.h>
#define SWAP(type,a,b) { type temp = a; a = b; b = temp; }
int main(void)
{
int a = 10,b = 100;
printf("a = %3d : b = %3d\n",a,b);
SWAP(int,a,b)
printf("a = %3d : b = %3d\n",a,b);
return 0;
}
このプログラムの実行結果は、次の通りです。
a = 10 : b = 100a = 100 : b = 10
もちろん、同じ変数を指定した場合にも問題なく動作します。
この方式では変数宣言のために{}で囲んでいるため、
;をつけなくても文として完結しています。
最後に;はつけないのが良いでしょう。
最後に;をつけられないのは気持ち悪いという人は
#define swap(type,a,b) do{type _c;_c=a;a=b;b=_c;}while(0)
としてやればマクロだけでは文として完結しないので、
最後に;をつけて動作するようになります。