NWChemEx / NWChemEx/PluginPlay

Memoization Considerations for ModuleBase

Open
#229 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
13
Forks
1
Avg merge
43m
Merged PRs (30d)
4

Description

Right now whether a module can be memoized or not is handled by the Module class. The module developer ultimately knows whether memoization of a module is even possible. There needs to be a mechanism for module developers to signal whether or not their module is memoizable. This issue proposes a similar API to that of the Module class namely:

  • add bool m_is_memoizable_ to ModuleBase (defaults to true)
  • add public method bool is_memoizable() const noexcept to ModuleBase
  • add protected method void turn_on_memoization() noexcept to ModuleBase
  • add protected method void turn_off_memoization() noexcept to ModuleBase
  • Have ModuleBase::is_memoizable() == false always make Module::is_memoizable() return false

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the ModuleBase and Module classes to understand their existing memoization APIs and how the two classes interact. Implement the proposed ModuleBase state and accessors, ensure a non-memoizable ModuleBase forces Module::is_memoizable() to return false, and verify the behavior with focused tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend-api-design
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.