「数学」関数は数学表記に従うべきですか？

この質問にはすぐに主観的なフラグが立てられると思いますが、どちらが良いと思いますか：

double volume(double pressure, double n_moles, double temperature) {
  return n_moles * BOLTZMANN_CONSTANT * temperature / pressure;
}

または

double volume(double P, double n, double T) {
  return n*R*T/P;
}

言い換えると、いくつかの式を実装する関数は、その式の表記法に従うべきですか、それともより詳細な名前を使用する必要がありますか？

誰がそれを読んでいるかに依存します。永遠に保証できるなら、あなたのコードを読む次のプログラマーも熱力学に精通しています。

私の個人的なスタイルは、そのような変数（その省略形は一般にフィールドで知られています）を使用しますが、コメントにその説明を含めます。

/* P : Pressure
   V : Volume
   n : Number of moles
   R : Boltzmann constant
   T : Temperature (in K)
*/
double compute_V(double P, double n, double T) {
  return n*R*T/P;
}

それをそこに投げるだけで、別のオプションがあります：

Volume ComputeVolume(Pressure p, Moles m, Temperature t) { ... }

これは、F＃が測定単位で行うことと多少似ており、不注意で圧力を温度に置き換えるなどの問題を回避できるという利点があります。署名が（double、double、double）のような場合、どの引数がどこに行くべきかを目で確認するのは難しい

私はこれが好きです：

/* This function calculates volume using the following formula:
 *
 *     n * R * T
 * v = ---------
 *         P
 */
double volume(double pressure, double n_moles, double temperature) {
    return n_moles * BOLTZMANN_CONSTANT * temperature / pressure;
}

言い換えれば、コメント内のコードの意味を英語で説明します（数学;コメントです。必要に応じて拡張できます）が、説明的な変数名を使用して、コードを読んでいる人でも理解できるようにしますそれは簡単です-特に大きな関数では。変数名として実際の単語を使用するもう1つの理由は、関数宣言をヘッダーファイルにコピーする必要がある場合、インターフェイスがはるかに明確になることです。

私見では、機能が非常にドメイン固有である場合は、作業している問題のあるドメインの確立された表記を使用することを常にお勧めします。問題のあるドメインを理解していない人は、コードを正常に維持する機会がありません。ドメインに精通している人にとっては、長い名前はただのノイズであり、あなたのためのタイピングが増えます。

OTHO、私は従来の数学表記がもっと冗長で記述的であることを望みますが、数学コードは数学の慣習に従うべきだと思います。

編集：この答えは、数式を数学的に記述するときに表記法に非常に強い規則がある場合にのみ適用されます。存在しない場合、読者がドメインに精通していると仮定しても、変数がコメントで何を表すかを説明する必要がある場合は、より説明的な慣習の側で間違いを犯すのが最善です。

純粋な意見ですが、常に一文字の記号よりも言葉を使用します。言葉を使うと、誰もが理解するでしょう。シンボルを使用する場合、主題の専門家のみがフォローすることが保証されます。それでも、同じ物理量に対して異なる記号を使用する人もいます。長い名前を使用しても、失うものは何もありません。

懸念事項は明快さ、次に正確さ（正しくないが、明確なコードは簡単に修正できる）でなければならないため、汎用コーダーによる保守性のために、可能な限り関数を作成する必要があります。関数ヘッダーのコメントは、式とその使用法を説明し、入力/出力パラメーターを記述する必要があります。その後、関数の本文がどのようにレイアウトされるかは、ヘッダーのコメントと一致している限り、重要ではありません。

（これは議論ではないことを知っていますが、私の個人的な好みは変数に明示的な名前を付けることですが、この場合は「純粋な」関数であるため、1行で十分です。同じパラメータで呼び出しても同じ結果が得られます常に結果が得られるため、説明が必要な状態関連の複雑さはありません）

• 次元分析をサポートする他の言語については、これはテンプレートを使用したC ++などで実装でき、Boost Unitsライブラリはこのアプローチを使用すると考えています。

コードがビジネスレイヤーからどの程度「離れている」かによって異なります...コードがスタックに戻ってくると、抽象数学関数が実装されることをよりターゲットにすればするほど、一般に受け入れられているものをエミュレートしようとします。数学表記と命名規則..フロントエンドまたはビジネスレイヤに近づくほど、問題領域で確立された規則に準拠するようになります。

私はこのように考えるのが好きです- 数学者は短い変数で誤解し、物理学者はそれに続きました。なぜ彼らの間違いを繰り返すのですか？長い名前の方がわかりやすく、混乱が少ないことがわかっているため、改善に固執します。軽いメモでは、私は時々、より長い変数を私の数学に忍び込ませようとします。

プログラミング方程式の正しい形式は、6か月間見なかった後でも理解できる形式です。

戻ってきたら：

n*R*T/P;

そして、あなたは何が起こっているかを認識し、それでおそらく大丈夫です。一般的に、高度な数式のために私は文句を言わない、私は積極的にそれを使用していない限り、各部分が何だったか覚えています。私のために：

n_moles * BOLTZMANN_CONSTANT * temperature / pressure;

特に方程式がそのまま書かれている理由が必ずしもわからない場合でも、各部分を簡単に理解できるため、特に優れた方程式形式です。

コインを投げます。

また、コーディング自体に費やすよりも、変数に名前を付ける方法について考えるのに時間をかけることはありますか？