getter/setterの命名 - Githubissues

KowerKoint commented 3 months ago

PauliOperator::get_coef、internal::XGateImpl::targetなど、getterにはメンバの名前にget_がついているものとついていないものがある。また、StateVector::amplitudesのようにgetterに見えて実際はタダのメンバ取得ではなく大きなコピーがかかっているものもある。これらをわかりやすくなるために、以下の命名規則を採用する。

メンバに直接アクセスする場合、または実際にはmaskなど他の持ち方をしているがそこからの変換コストが低くメンバとして直接持っているかのように振る舞いたい場合
- メンバと同じ名前の関数
- 返り値はプリミティブ型やComplexのように十分コピーコストが小さければT、vectorのように大きければconst T&で返す
- 可変にしたい場合、同名の非const関数でsetterを定義する。返り値はT&。もし本当はその形で持っていないならinternal::BitVector::_Referenceのように参照型のように振る舞うラッパークラスを返してもよいが、現状そういうものはなさそう。
計算して結果を返す場合
- get_つきまたはその他の適切な動詞型の名前をつける。
- get_target_qubit_list、get_target_qubit_maskに関してはどうするべきか要検討(これは統一して両方getでもいいかも？)

gandalfr-KY commented 2 months ago

get_target_qubit_list、get_target_qubit_maskに関してはどうするべきか要検討(これは統一して両方getでもいいかも？)

これはまさに「メンバに直接アクセスする場合、または実際にはmaskなど他の持ち方をしているがそこからの変換コストが低くメンバとして直接持っているかのように振る舞いたい場合」ではないですか？これに照らせばgetを付けない名前がよいのではないでしょうか。

gandalfr-KY commented 2 months ago

https://github.com/qulacs/scaluq/pull/161

KowerKoint commented 2 months ago

これに照らせばgetを付けない名前がよいのではないでしょうか。

ゲートによっては(Probablisticとか)取得が難しいというイメージだったけど、　だいたい一瞬だしProbablisticも今例外で今後コンストラクタでマスク作るくらいでいい気もするのでgetつけなくていいかも

qulacs / scaluq

getter/setterの命名 #145