NWChemEx / NWChemEx/TensorWrapper

Buffer and TensorWrapper comparisons

Open
#51 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
0
Forks
0
Avg merge
5h 33m
Merged PRs (30d)
6

Description

Brought on by discussion in #42, we need a way to compare two Buffer (and eventually TensorWrapper) instances which ensures the metadata of the tensor (distribution, sparsity, etc.) is equal and that the elements of the tensor are equal to within some criteria (an effective epsilon). This contrasts with operator== which should be value equal for all members. For Buffer I'm fine with adding an additional argument to are_equal, for TensorWrapper maybe a function approximately_equal?

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 locating Buffer::are_equal and operator==, then inspect the TensorWrapper comparison interface. Define how metadata equality and epsilon-based element comparison should work for Buffer and TensorWrapper; done means both types have comparisons covering the requested metadata and element criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.