fix .zero() for multi-dimensional arrays

Author: gewang

VERSIONS

@@ -2,6 +2,16 @@
 ChucK VERSIONS log
 ------------------
 
+1.5.5.1
+=======
+(fixed) array.zero() now works properly with multi-dimensional arrays; previously
+    it would zero out the top-level array elements (which are actually the next
+    level of inner arrays, since multi-dimensional array in chuck are arrays of
+    arrays of arrays...)
+(updated) examples/array/array_zero.ck now includes example of using .zero() with
+    multi-dimensional arrays (thanks to @terryzfeng for reporting this issue)
+
+
 1.5.5.0 (March 2025)
 =======
 (added) ChuMP: ChucK Manager of Packages! v0.0.1 (alpha)

examples/array/array_zero.ck

@@ -1,5 +1,8 @@
 // .zero() zeros out the contents AND keeps size unchanged
 // version: need chuck-1.5.0.0 or higher
+//
+// NOTE: using .zero() with multidimensional arrays
+//       requires chuck-1.5.5.1 or higher
 
 // an array
 [1,3,4] @=> int array[];
@@ -12,3 +15,23 @@ array.zero();
 
 // now should print 0 3
 <<< array[1], array.size() >>>;
+
+// a multi-dimensional array
+[ [1,2], [3,4] ] @=> int array2[][];
+
+// NOTE: using .zero() with multidimensional arrays
+//       requires chuck-1.5.5.1 or higher
+array2.zero();
+
+// iterate over array2
+for( int inner[] : array2 )
+{
+    // iterate over each inner array
+    for( int x: inner )
+    {
+        // print each element within
+        cherr <= x <= " ";
+    }
+}
+// print newline
+cherr <= IO.nl();

src/core/chuck_oo.cpp

@@ -1027,6 +1027,48 @@ void Chuck_ArrayInt::clear( )
 
 
 
+//-----------------------------------------------------------------------------
+// name: zero()
+// desc: zero out an int/object array
+//       1.5.5.1 (ge) handle multidimensional arrays
+//-----------------------------------------------------------------------------
+void Chuck_ArrayInt::zero()
+{
+    // if primitive int
+    if( this->m_is_obj == FALSE )
+    {
+        // zero out
+        this->zero( 0, m_vector.size() );
+        // done
+        return;
+    }
+
+    // array contains object;
+    // check if the objects are themselves arrays | 1.5.5.1 (ge)
+    if( this->type_ref->array_depth > 0 )
+    {
+        // iterate over elements
+        for( t_CKUINT i = 0; i < m_vector.size(); i++ )
+        {
+            // if NULL, move to next
+            if( !m_vector[i] ) continue;
+
+            // cast to base array pointer
+            Chuck_Array * array = (Chuck_Array *)m_vector[i];
+            // call the array's zero()
+            array->zero();
+        }
+    }
+    else // array contains non-array object references
+    {
+        // zero out
+        this->zero( 0, m_vector.size() );
+    }
+}
+
+
+
+
 //-----------------------------------------------------------------------------
 // name: set_capacity()
 // desc: ...

src/core/chuck_oo.h

@@ -315,7 +315,7 @@ struct Chuck_ArrayInt : public Chuck_Array
     // zero out the array by range [start,end)
     virtual void zero( t_CKUINT start, t_CKUINT end );
     // zero out all elements
-    virtual void zero() { this->zero(0, m_vector.size()); }
+    virtual void zero();
 
     // pop the back of the array
     virtual t_CKINT pop_back();

src/test/01-Basic/119.ck

@@ -7,6 +7,27 @@ array[1] => int three;
 // zero out the array, leaving size as is
 array.zero();
 
-// check: size should be 3 but array[1] should now be zero
-if( three == 3 && array.size() == 3 && array[1] == 0 )
-    <<< "success" >>>;
+// print (should be three 3s)
+<<< three, array.size(), array[1] >>>;
+
+// using .zero() with multidimensional arrays
+// NOTE: requires chuck-1.5.5.1 or higher
+[ [1,2], [3,4] ] @=> int array2[][];
+
+// zero out the multidimensional array, leaving size as is
+array2.zero();
+
+// iterate over array2
+for( int inner[] : array2 )
+{
+    // iterate over each inner array
+    for( int x: inner )
+    {
+        // print each element within
+        cherr <= x <= " ";
+    }
+}
+// print newline
+cherr <= IO.nl();
+
+