DOC: Knowledge base gives the wrong reason for the requireArraysInMemory call order

オープン 初心者向け
#1,980 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 6 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
74/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
cpp
領域
documentation

調査の方向性

docs/Coding_Knowledge_Base.md の1097~1100行目にある requireArraysInMemory の項目から始め、次に IParallelAlgorithm.cpp の82~91行目および IParallelAlgorithm.hpp の43~44行目と比較して、各呼び出しで無効状態が維持されていることを確認してください。その理由を示し、require の呼び出しの前に setParallelizationEnabled(true) を呼び出すよう指示するように項目を書き直してください。項目がコードおよびヘッダーのコメントと一致すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation

Summary

The rule for requireArraysInMemory() in the coding knowledge base gives the wrong reason for its call order. The text should describe what the code does.

What the knowledge base says. docs/Coding_Knowledge_Base.md lines 1097-1100: "Each call replaces the previous decision, so call it once with all arrays, and call setParallelizationEnabled(false) after it, not before."

How it works now. IParallelAlgorithm.cpp lines 82-91 combines each call with the current state:

setParallelizationEnabled(getParallelizationEnabled() && CheckArraysInMemory(arrays));

So a call never re-enables parallel work. It only keeps or sets the disabled state. The header says the same thing (IParallelAlgorithm.hpp lines 43-44): "Each call preserves a disabled state. Call setParallelizationEnabled(true) to reset the state in a multicore build."

Why it matters. The advice itself is still safe, but the stated reason is wrong. A developer who believes that a later call replaces an earlier one may split the arrays across several calls and expect only the last to count, or may call setParallelizationEnabled(true) after the require calls and silently turn the out-of-core gate off.

Where it applies. Only the knowledge-base entry. The request is to state the real rule: each call keeps a disabled state, and setParallelizationEnabled(true) resets it, so call it before the require calls, never after.

Found during the review of the #1908 batch 4 changes (FeatureFaceCurvature out-of-core gate). No open issue covered it.

主要言語
C++
スター
18
フォーク
15
平均マージ
4日 23時間
マージ済み PR(30日)
42

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

BlueQuartzSoftware/simplnx のほかの issue

BlueQuartzSoftware/simplnx の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。