arkouda icon indicating copy to clipboard operation
arkouda copied to clipboard

Add documentation for adding new `SymEntry` class to the symbol table

Open stress-tess opened this issue 3 years ago • 3 comments

During the arkouda weekly call, it was expressed that we need documentation for more advanced contributions to arkouda (beyond the how to add a new command-message)

In particular @zhihuidu is looking for in depth docs on how to add a new SymEntry class the symbol table. The most logical place for this to go seems to be the development how to wiki

stress-tess avatar Sep 13 '22 17:09 stress-tess

Yes, currently we have two symbol table entries. One is GraphSymEntry and the other is DomArraySymEntry. We use GraphSymEntry to abstract a complete graph. However, DomArraySymEntry is used to abstract a special component of a graph. The edge and vertex arrays (distributed one dimension integer arrays) are components of a graph. All edge arrays have the same size. All vertex arrays also have the same size. However, for aligned arrays, their sizes can be different from each other. Currently, we define GraphSymEntry and DomArraySymEntry as the son classes of CompositeSymEntry.

zhihuidu avatar Sep 13 '22 19:09 zhihuidu

I was thinking that the wiki is a bit to ephemeral for me and would like to see updated doc in the Arkouda documentation.

mhmerrill avatar Sep 15 '22 13:09 mhmerrill

I will help the team accomplish this activity.

kaydoh avatar Sep 16 '22 20:09 kaydoh