fix: rename default to ring

Author: Sh0g0-1758

.github/workflows/test.yml

@@ -29,9 +29,9 @@ jobs:
       run: |
         make CHARMC=./charm-v7.0.0/bin/charmc build-simulation
 
-    - name: Test allGather DEFAULT
+    - name: Test allGather RING
       run: |
-        make CHARMC=./charm-v7.0.0/bin/charmc TYPE=DEFAULT test-simulation
+        make CHARMC=./charm-v7.0.0/bin/charmc TYPE=RING test-simulation
 
     - name: Test allGather HYPERCUBE
       run: |

Makefile

@@ -1,6 +1,6 @@
 CHARMC ?= charmc
 FLAGS = -g -Wall -O2
-TYPE ?= DEFAULT
+TYPE ?= RING
 ALLGATHER_DIR=./src/allGather
 EXAMPLE_DIR=./example
 

README.md

@@ -4,7 +4,7 @@ A library for implementing collectives commonly used in machine learning tasks i
 
 ## allGather
 
-allGather lets you gather data distributed accross different chare array elements. The library provides 3 algorithms for doing the allGather operations, namely naive, hypercube and flooding. 
+allGather lets you gather data distributed accross different chare array elements. The library provides 3 algorithms for doing the allGather operations, namely ring, hypercube and flooding.
 
 ### How to use
 
@@ -13,14 +13,14 @@ declare allGather as an extern module in your `.ci` file and include the `allGat
 ```C++
 CkArrayOptions opts(n);
 opts.bindTo(sim);
-AllGather_array = CProxy_AllGather::ckNew(k, n, (int)allGatherType::ALL_GATHER_DEFAULT, opts);
+AllGather_array = CProxy_AllGather::ckNew(k, n, (int)allGatherType::ALL_GATHER_RING, opts);
 ```
 
 Here n refers to the size of the chare array, k refers to the number of data elements present in each chare array element and the third parameter lets you choose the algorithm you want to run. The algorithms are:
 
 ```C++
 enum allGatherType {
-  ALL_GATHER_DEFAULT,
+  ALL_GATHER_RING,
   ALL_GATHER_HYPERCUBE,
   ALL_GATHER_FLOODING
 };

example/user.cc

@@ -28,8 +28,8 @@ start::start(CkArgMsg *msg) {
   AllGather_array = CProxy_AllGather::ckNew(k, n, (int)allGatherType::ALL_GATHER_HYPERCUBE, opts);
 #endif
 
-#ifdef DEFAULT
-  AllGather_array = CProxy_AllGather::ckNew(k, n, (int)allGatherType::ALL_GATHER_DEFAULT, opts);
+#ifdef RING
+  AllGather_array = CProxy_AllGather::ckNew(k, n, (int)allGatherType::ALL_GATHER_RING, opts);
 #endif
 
   sim.begin(AllGather_array);

src/allGather/allGather.cc

@@ -40,7 +40,7 @@ AllGather::AllGather(int k, int n, int type) : k(k), n(n) {
       }
     }
   } break;
-  case allGatherType::ALL_GATHER_DEFAULT: {
+  case allGatherType::ALL_GATHER_RING: {
   } break;
   }
 }
@@ -75,15 +75,15 @@ void AllGather::startGather() {
     store[k * thisIndex + i] = data[i];
   }
   CkNcpyBuffer src(data, k*sizeof(long int), dum_dum, CK_BUFFER_UNREG);
-  
+
   switch (type) {
-  case allGatherType::ALL_GATHER_DEFAULT: {
+  case allGatherType::ALL_GATHER_RING: {
 #ifdef TIMESTAMP
-    thisProxy[(thisIndex + 1) % n].recvDefault(
+    thisProxy[(thisIndex + 1) % n].recvRing(
         thisIndex, src, (timeStamp + alpha + beta * k * 8));
     timeStamp += alpha;
 #else
-    thisProxy[(thisIndex + 1) % n].recvDefault(thisIndex, src, 0.0);
+    thisProxy[(thisIndex + 1) % n].recvRing(thisIndex, src, 0.0);
 #endif
   } break;
   case allGatherType::ALL_GATHER_HYPERCUBE: {
@@ -108,19 +108,19 @@ void AllGather::startGather() {
   }
 }
 
-void AllGather::recvDefault(int sender, CkNcpyBuffer src, double recvTime) {
+void AllGather::recvRing(int sender, CkNcpyBuffer src, double recvTime) {
   CkNcpyBuffer dst(store + sender * k, k * sizeof(long int), zero_copy_callback, CK_BUFFER_UNREG);
   dst.get(src);
 #ifdef TIMESTAMP
   timeStamp = std::max(recvTime, timeStamp);
 #endif
   if (((thisIndex + 1) % n) != sender) {
 #ifdef TIMESTAMP
-    thisProxy[(thisIndex + 1) % n].recvDefault(
+    thisProxy[(thisIndex + 1) % n].recvRing(
         sender, src, (timeStamp + alpha + beta * k * 8));
     timeStamp += alpha;
 #else
-    thisProxy[(thisIndex + 1) % n].recvDefault(sender, src, 0.0);
+    thisProxy[(thisIndex + 1) % n].recvRing(sender, src, 0.0);
 #endif
   }
 }

src/allGather/allGather.ci

@@ -9,7 +9,7 @@ module allGather {
     entry AllGather(int size, int n, int type);
     entry[reductiontarget] void initdone(int num);
     entry void startGather();
-    entry void recvDefault(int sender, CkNcpyBuffer data, double recvTime);
+    entry void recvRing(int sender, CkNcpyBuffer data, double recvTime);
     entry void local_buff_done(CkDataMsg *m);
     entry void Hypercube() {
       for(iter = 0; iter < numHypercubeIter; iter++) {

src/allGather/allGather.hh

@@ -13,7 +13,7 @@ class allGatherMsg : public CMessage_allGatherMsg {};
 
 // NB: ALL_GATHER_HYPERCUBE only works when the size of chare array is a power of 2.
 enum allGatherType {
-  ALL_GATHER_DEFAULT,
+  ALL_GATHER_RING,
   ALL_GATHER_HYPERCUBE,
   ALL_GATHER_FLOODING
 };
@@ -47,7 +47,7 @@ public:
 
   void startGather();
 
-  void recvDefault(int sender, CkNcpyBuffer data, double recvTime);
+  void recvRing(int sender, CkNcpyBuffer data, double recvTime);
 
   void local_buff_done(CkDataMsg *m);