ORNL / ORNL/ReSolve

Naming scheme for vector classes

Open
#18 2 comments 0 reactions 2 assignees View on GitHub

@pelesh is already working on this.

Since Oct 18, 2023.

enhancement question
Dominant language
C++
Stars
84
Forks
13
PR merge metrics
No merged PRs in 30d

Description

It might be a good idea to decide on vector naming schemes. I think it would be important to have these schemes analog to what we settled on for matrices. Here are a few suggestions:

  • Rename namespace vector to multivector. Then rename Vector class to Dense in analogy with matrix objects. The class will be called as multivector::Dense, i.e. this convention would include that using namespace multivector is never invoked.
  • Alternatively, we could keep the namespace as vector and rename the class MultiDense, so the invocation of the type name would be vector::MultiDense. This name is a little bit cumbersome, but it also allows us to derive single vector from multivector class trivially and then have another type name vector::SingleDense. This may provide more flexibility.

Once we decide, it is straightforward to update names of classes and files.

@kswirydo @cameronrutherford @rothpc please chime in.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.