Add ELL accessor methods

[KyleVaughn]

Description:

This task defines the accessor methods for the ELL matrix. These methods are used to access protected or private variables of the class. These methods could be used by most other portions of the library. For example, the accessor for matrix coefficients could be used by the matrix-vector method to perform the computations. This task helps to fulfill the functional requirement "The library shall provide interfaces to return or define a matrix in ELLPACK format." because it allows the user to get and set information relevant to the ELLPACK format.

Tasks:

• [ ] Identify exactly where these methods would be used in the process of receiving an input matrix, storing it, converting its storage, and using it in matrix-vector multiplication
• [ ] communicate with others who depend on this method and who's work this method is dependent on
• [ ] develop get and set methods for all relevant attributes. These would likely include matrix coefficients, their indices, and general properties of the matrix.
• [ ] determine if set coefficient methods need to be able to add elements into storage instead of replacing existing ones
• [ ] determine all the attributes that would be relevant to this library.
• [ ] collaborate with other accessor developers and determine their method for implementing and interface

Definition of done:

This task can be complete if methods have been implemented and tested to get and set all relevant attributes. At the bare minimum, the getFormat() and operator()(size_t i, size_t j) methods must be included.

[KyleVaughn]

Review by @AvirupSircar

[jacob-umich]

What is the common interface we need to specify for our accessors? I am not sure. @maxzog @AvirupSircar @marchier. Also, I don't think there is an issue assigned for JDS accessors? what do you think about that? do they not need one?

Max mentioned operator()(size_t i, size_t j) would be the best interface for the SparseMatrix class

[bkochuna]

Probably don’t have enough students to have that issue defined

On Fri, Oct 13, 2023 at 11:15 AM jacob-umich @.***> wrote:

What is the common interface we need to specify for our accessors? I am not sure. @maxzog https://github.com/maxzog @AvirupSircar https://github.com/AvirupSircar @marchier https://github.com/marchier. Also, I don't think there is an issue assigned for JDS accessors? what do you think about that? do they not need one?

— Reply to this email directly, view it on GitHub https://github.com/bkochuna/ners570f23-SpMV/issues/45#issuecomment-1761685871, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABHRN4NUCEUW6UT5FBTU5PTX7FLHHANCNFSM6AAAAAA56SRYCA . You are receiving this because you are subscribed to this thread.Message ID: @.***>

[jacob-umich]

@maxzog @AvirupSircar @marchier Accessor ppl. Please update this comment with the attributes you think should have accessor functionality. This way, it is all consistent.

Get method

• n_rows (already implemented)
• n_cols (already implemented)
• n_nonzeros (already implemented)
• state (already implemented)
• format (needs implementing)
• buildCoeff (needs implementing, needs to be accessed in a format-specific way)

Set method

• buildCoeff (already implemented) I'm not sure what would need set functionality. in the current source, many of the attributes are just set in other methods (in SparseMatrix<fp_type>::setCoefficient for example)

[AvirupSircar]

Looks fine. The following can be a starting bunch of accessor methods, https://github.com/bkochuna/ners570f23-SpMV/issues/43 . The other methods will depend on how the underlying SpMv classes are designed which needs to be collaborated and decided.

[maxzog]

Hello @bkochuna, to follow up on my question in class last week - what should the accessor method be accessing? I've gotten conflicting information. Should it just get the matrix format (enum type) and the coefficient at an (i,j) index or should it also be able to return the other matrix properties listed in the comment above?