ソースコードのコメントに数式を書くには、TeX がいい
Deep Learning 全盛の今日、ソースコードのコメントに数式を書きたい時もあることでしょう。そんな時、プログラミング言語の表し方で書いても、単にソースコードになってしまい冗長です。ソースコードに画像を埋め込むこともできません。ここは TeX を利用して書くのが cool です。
例えばこれは、Deep Learning ではよく見られる総和の式ですが、プログラムにするとこんな感じです。
double sum = 0;
int I = 748;
int i = 1;
int j = 1;
for(i=1; i<=I; i++){
sum = sum + (w[j][i] * x[i]) + b[j];
}
u[j] = sum;
プログラマーは、数式で見るよりソースコードで見れば一目瞭然ですが、やはり、他人に見せるソースコードにはコメントを入れるのが作法です。しかし、前述の通り、コメントもコードと同じ記述になりがちです。ですから、TeX(ここでは LaTeX ですが)を利用してコメントを記述します。
double sum = 0;
int I = 748;
int i = 1;
int j = 1;
// u_{j} = \sum_{i=1}^I \omega_{ji} x_i + b_j
for(i=1; i<=I; i++){
sum = sum + (w[j][i] * x[i]) + b[j];
}
u[j] = sum;
どうでしょうか。とても cool なコメントになりました。これで、誰にも文句は言われません。
以上
この記事が気に入ったらサポートをしてみませんか?