type_array 0.2 → 0.3

data/CHANGELOG.rdoc

@@ -1,4 +1,13 @@
 = Changelog
 
+== 0.3.0 (July 18th, 2012)
+* Introduce support for setting operator results at a given offset without coercion to a Ruby object
+* Let TypeArray be enumerable as well
+* Support Marshal dump / load
+
+== 0.2.0 (July 12th, 2012)
+* Introduce support for lower level comparison at given offsets (avoids excess Ruby object allocations)
+* Introduce support for lower level math operations at given offsets (avoids excess Ruby object allocations)
+
 == 0.1.0 (July 11th, 2012)
 * initial release

data/README.rdoc

@@ -130,7 +130,6 @@ Running tests
 
 == Todo
 
-* Support Marshal dump / load
 * Support structs / records
 * Handle edges where coercion to and from Bignum is more appropriate
 

data/bench/get_set.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('lib')
+require 'type_array'
+require 'benchmark'
+
+typed = Float32Array.new(1_000_000)
+native = Array.new(1_000_000)
+
+
+Benchmark.bmbm do |x|
+  x.report("typed array []=") do
+    1_000_000.times {|i| typed[i] = 0.1234567890123456; typed[i] }
+  end
+
+  x.report("array []=") do
+    1_000_000.times {|i| native[i] = 0.1234567890123456; typed[i] }
+  end
+end

data/bench/operators.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('lib')
+require 'type_array'
+require 'benchmark'
+
+buf = ArrayBuffer.new(24)
+
+typed = Float64Array.new(buf)
+
+typed[0] = 2.33
+typed[1] = 2.33
+typed[2] = 7.45
+native = [2.33, 2.33, 7.45]
+
+
+Benchmark.bmbm do |x|
+  x.report("type array eql") do
+    1_000_000.times {|i| typed.eql(0,1) }
+  end
+
+  x.report("type array mul") do
+    1_000_000.times {|i| typed.mul(0,1) }
+  end
+
+  x.report("array eql") do
+    1_000_000.times {|i| native[0] == native[1] }
+  end
+
+  x.report("array mul") do
+    1_000_000.times {|i| native[0] * native[1] }
+  end
+end

data/ext/type_array/type_array.c

@@ -237,7 +237,8 @@ DefineTypeArrayOperator(eql, ==, float64, double, (val == 0 ? Qfalse : Qtrue));
  *  Asserts type alignment.
  *
 */
-inline int rb_type_array_assert_alignment(unsigned long val, unsigned long bytes) {
+inline int rb_type_array_assert_alignment(unsigned long val, unsigned long bytes)
+{
     return (val & (bytes - 1)) == 0 ? 1 : 0;
 }
 
@@ -246,7 +247,8 @@ inline int rb_type_array_assert_alignment(unsigned long val, unsigned long bytes
  *  Swizzles byte order.
  *
 */
-inline void rb_type_array_swizzle(char* buf, unsigned long len) {
+inline void rb_type_array_swizzle(char* buf, unsigned long len)
+{
     unsigned long i;
     for (i = 0; i < len / 2; ++i) {
       char t = buf[i];
@@ -257,14 +259,12 @@ inline void rb_type_array_swizzle(char* buf, unsigned long len) {
 
 /*
  * :nodoc:
- *  Validates offset boundaries.
+ *  Validates offset boundaries (no index coercion)
  *
 */
-static inline long rb_type_array_assert_offset(rb_type_array_t *ary, VALUE idx)
+static inline long rb_type_array_assert_offset0(rb_type_array_t *ary, long idx)
 {
-    long index;
-    Check_Type(idx, T_FIXNUM);
-    index = FIX2LONG(idx) * ary->size;
+    long index = idx * ary->size;
     if (index < 0) rb_raise(rb_eRangeError, "Offset may not be negative.");
     if (!rb_type_array_assert_alignment(index, ary->size)) rb_raise(rb_eRangeError, "Byte offset is not aligned.");
     if ((unsigned long)index > ary->byte_length) rb_raise(rb_eRangeError, "Offset out of range.");
@@ -272,6 +272,17 @@ static inline long rb_type_array_assert_offset(rb_type_array_t *ary, VALUE idx)
     return index;
 }
 
+/*
+ * :nodoc:
+ *  Validates offset boundaries.
+ *
+*/
+static inline long rb_type_array_assert_offset(rb_type_array_t *ary, VALUE idx)
+{
+    Check_Type(idx, T_FIXNUM);
+    return rb_type_array_assert_offset0(ary, FIX2LONG(idx));
+}
+
 /*
  * :nodoc:
  *  GC mark callback
@@ -502,13 +513,16 @@ static VALUE rb_type_array_byte_length(VALUE obj)
  *     ary.mul(0,1)                      =>  8
  *     ary.mul(1,2)                      =>  32
 */
-static VALUE rb_type_array_mul(VALUE obj, VALUE off1, VALUE off2)
+static VALUE rb_type_array_mul(int argc, VALUE *argv, VALUE obj)
 {
+    VALUE off1, off2, off3;
     GetTypeArray(obj);
     GetArrayBuffer(ary->buf);
+    rb_scan_args(argc, argv, "21", &off1, &off2, &off3);
     long offset1 = rb_type_array_assert_offset(ary, off1);
     long offset2 = rb_type_array_assert_offset(ary, off2);
-    return ary->mul_fn(buf->buf, offset1, offset2);
+    long offset3 = NIL_P(off3) ? 0 : rb_type_array_assert_offset(ary, off3);
+    return ary->mul_fn(buf->buf, offset1, offset2, offset3);
 }
 
 /*
@@ -527,13 +541,16 @@ static VALUE rb_type_array_mul(VALUE obj, VALUE off1, VALUE off2)
  *     ary.plus(0,1)                     =>  6
  *     ary.plus(1,2)                     =>  12
 */
-static VALUE rb_type_array_plus(VALUE obj, VALUE off1, VALUE off2)
+static VALUE rb_type_array_plus(int argc, VALUE *argv, VALUE obj)
 {
+    VALUE off1, off2, off3;
     GetTypeArray(obj);
     GetArrayBuffer(ary->buf);
+    rb_scan_args(argc, argv, "21", &off1, &off2, &off3);
     long offset1 = rb_type_array_assert_offset(ary, off1);
     long offset2 = rb_type_array_assert_offset(ary, off2);
-    return ary->plus_fn(buf->buf, offset1, offset2);
+    long offset3 = NIL_P(off3) ? 0 : rb_type_array_assert_offset(ary, off3);
+    return ary->plus_fn(buf->buf, offset1, offset2, offset3);
 }
 
 /*
@@ -552,13 +569,16 @@ static VALUE rb_type_array_plus(VALUE obj, VALUE off1, VALUE off2)
  *     ary.minus(1, 0)                   =>  2
  *     ary.minus(2, 1)                   =>  4
 */
-static VALUE rb_type_array_minus(VALUE obj, VALUE off1, VALUE off2)
+static VALUE rb_type_array_minus(int argc, VALUE *argv, VALUE obj)
 {
+    VALUE off1, off2, off3;
     GetTypeArray(obj);
     GetArrayBuffer(ary->buf);
+    rb_scan_args(argc, argv, "21", &off1, &off2, &off3);
     long offset1 = rb_type_array_assert_offset(ary, off1);
     long offset2 = rb_type_array_assert_offset(ary, off2);
-    return ary->minus_fn(buf->buf, offset1, offset2);
+    long offset3 = NIL_P(off3) ? 0 : rb_type_array_assert_offset(ary, off3);
+    return ary->minus_fn(buf->buf, offset1, offset2, offset3);
 }
 
 /*
@@ -577,20 +597,23 @@ static VALUE rb_type_array_minus(VALUE obj, VALUE off1, VALUE off2)
  *     ary.div(1, 0)                     =>  2
  *     ary.div(2, 1)                     =>  2
 */
-static VALUE rb_type_array_div(VALUE obj, VALUE off1, VALUE off2)
+static VALUE rb_type_array_div(int argc, VALUE *argv, VALUE obj)
 {
+    VALUE off1, off2, off3;
     GetTypeArray(obj);
     GetArrayBuffer(ary->buf);
+    rb_scan_args(argc, argv, "21", &off1, &off2, &off3);
     long offset1 = rb_type_array_assert_offset(ary, off1);
     long offset2 = rb_type_array_assert_offset(ary, off2);
-    return ary->div_fn(buf->buf, offset1, offset2);
+    long offset3 = NIL_P(off3) ? 0 : rb_type_array_assert_offset(ary, off3);
+    return ary->div_fn(buf->buf, offset1, offset2, offset3);
 }
 
 /*
  *  call-seq:
- *     ary.div(0,1)                      =>  Fixnum, Bignum or Float
+ *     ary.eql(0,1)                      =>  true or fales
  *
- *  Gets two values at given offsets and divides them - only the result's coerced to a Ruby object.
+ *  Gets two values at given offsets and compares them - a boolean's returned
  *
  * === Examples
  *     buf = ArrayBuffer.new(16)         =>  ArrayBuffer
@@ -599,8 +622,8 @@ static VALUE rb_type_array_div(VALUE obj, VALUE off1, VALUE off2)
  *     ary[1] = 4                        =>  nil
  *     ary[2] = 8                        =>  nil
  *
- *     ary.div(1, 0)                     =>  2
- *     ary.div(2, 1)                     =>  2
+ *     ary.eql(1, 0)                     =>  false
+ *     ary.eql(2, 2)                     =>  true
 */
 static VALUE rb_type_array_eql(VALUE obj, VALUE off1, VALUE off2)
 {
@@ -608,7 +631,7 @@ static VALUE rb_type_array_eql(VALUE obj, VALUE off1, VALUE off2)
     GetArrayBuffer(ary->buf);
     long offset1 = rb_type_array_assert_offset(ary, off1);
     long offset2 = rb_type_array_assert_offset(ary, off2);
-    return ary->eql_fn(buf->buf, offset1, offset2);
+    return ary->eql_fn(buf->buf, offset1, offset2, 0);
 }
 
 /*
@@ -732,9 +755,41 @@ static VALUE rb_type_array_aget(VALUE obj, VALUE idx)
     return ary->aref_fn(buf->buf, index);
 }
 
+/*
+ *  call-seq:
+ *     type_array.each {|item| block }   =>  TypeArray
+ *
+ *  Calls <i>block</i> once for each element in <i>self</i>, passing that element as a parameter.
+ *
+ * === Examples
+ *     buf = ArrayBuffer.new(16)         =>  ArrayBuffer
+ *
+ *     ary = Int32Array.new(buf)         =>  Int32Array
+ *     ary[0] = 2                        =>  nil
+ *     ary[1] = 4                        =>  nil
+ *     ary[2] = 8                        =>  nil
+ *     ary[3] = 16                       =>  nil
+ *
+ *     ary.map(&:to_s)                   =>  %w(2 4 8 16)
+ *
+*/
+static VALUE rb_type_array_each(VALUE obj)
+{
+    long index;
+    GetTypeArray(obj);
+    GetArrayBuffer(ary->buf);
+
+    RETURN_ENUMERATOR(obj, 0, 0);
+    for (index = 0; index < ary->length; index++) {
+        rb_yield(ary->aref_fn(buf->buf, (index * ary->size)));
+    }
+    return obj;
+}
+
 void _init_type_array()
 {
     rb_cTypeArray = rb_define_class("TypeArray", rb_cObject);
+    rb_include_module(rb_cTypeArray, rb_mEnumerable);
 
     rb_type_array_intern_aget = rb_intern("[]");
     rb_type_array_intern_aset = rb_intern("[]=");
@@ -766,9 +821,10 @@ void _init_type_array()
     rb_define_method(rb_cTypeArray, "to_s", rb_type_array_to_s, 0);
     rb_define_method(rb_cTypeArray, "[]=", rb_type_array_aset, 2);
     rb_define_method(rb_cTypeArray, "[]", rb_type_array_aget, 1);
-    rb_define_method(rb_cTypeArray, "mul", rb_type_array_mul, 2);
-    rb_define_method(rb_cTypeArray, "plus", rb_type_array_plus, 2);
-    rb_define_method(rb_cTypeArray, "minus", rb_type_array_minus, 2);
-    rb_define_method(rb_cTypeArray, "div", rb_type_array_div, 2);
+    rb_define_method(rb_cTypeArray, "mul", rb_type_array_mul, -1);
+    rb_define_method(rb_cTypeArray, "plus", rb_type_array_plus, -1);
+    rb_define_method(rb_cTypeArray, "minus", rb_type_array_minus, -1);
+    rb_define_method(rb_cTypeArray, "div", rb_type_array_div, -1);
     rb_define_method(rb_cTypeArray, "eql", rb_type_array_eql, 2);
+    rb_define_method(rb_cTypeArray, "each", rb_type_array_each, 0);
 }

data/ext/type_array/type_array.h

@@ -3,7 +3,7 @@
 
 typedef void (type_array_aset_fn) (rb_array_buffer_t *buf, long index, VALUE item);
 typedef VALUE (type_array_aref_fn) (rb_array_buffer_t *buf, long index);
-typedef VALUE (type_array_operator_fn) (rb_array_buffer_t *buf, long off1, long off2);
+typedef VALUE (type_array_operator_fn) (rb_array_buffer_t *buf, long off1, long off2, long off3);
 
 typedef struct {
     unsigned long size;
@@ -48,13 +48,18 @@ void _init_type_array();
     DefineTypeArrayOperator(div, /, name, type, coercion); \
 
 #define DefineTypeArrayOperator(op_name, op, name, type, coercion) \
-    VALUE rb_type_array_##op_name##_##name(rb_array_buffer_t *buf, long off1, long off2) \
+    VALUE rb_type_array_##op_name##_##name(rb_array_buffer_t *buf, long off1, long off2, long off3) \
     { \
         type val; \
         type val1 = rb_type_array_get_##name(buf, off1, TYPE_ARRAY_IS_LITTLE_ENDIAN); \
         type val2 = rb_type_array_get_##name(buf, off2, TYPE_ARRAY_IS_LITTLE_ENDIAN); \
         val = val1 op val2; \
-        return coercion; \
+        if (off3 != 0) { \
+            rb_type_array_set_##name(buf, off3, val, TYPE_ARRAY_IS_LITTLE_ENDIAN); \
+            return Qnil; \
+        } else { \
+            return coercion; \
+        } \
     }
 
 #endif

data/lib/type_array.rb

@@ -7,8 +7,9 @@ require "type_array_ext"
 
 require 'type_array/version' unless defined? TypeArray::VERSION
 require 'type_array/io'
+require 'type_array/marshal'
 
 [ArrayBuffer, TypeArray, DataView].each do |c|
   c.extend TypeArray::IOReader
-  c.send(:include, TypeArray::IOWriter)  
+  c.send(:include, TypeArray::IOWriter, TypeArray::Marshal)  
 end

data/lib/type_array/marshal.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module TypeArray::Marshal
+  def self.included(klass)
+    class << klass
+      def _load(str); new(str) end
+    end
+  end
+
+  def _dump(obj)
+    to_s
+  end
+end

data/lib/type_array/version.rb

@@ -1,3 +1,3 @@
 class TypeArray
-  VERSION = '0.2'
+  VERSION = '0.3'
 end

data/test/test_array_buffer.rb

@@ -66,6 +66,17 @@ class TestArrayBuffer < TypeArrayTestCase
     assert str.frozen?
   end
 
+  def test_marshal
+    buf = ArrayBuffer.new(4)
+    assert_equal "\x00\x00\x00\x00", buf.to_s
+
+    serialized = "\x04\bu:\x10ArrayBuffer\t\x00\x00\x00\x00"
+    assert_equal serialized, Marshal.dump(buf)
+
+    buf = Marshal.load(serialized)
+    assert_equal "\x00\x00\x00\x00", buf.to_s
+  end
+
   def test_io
     buf = ArrayBuffer.new(16)
 

data/test/test_data_view.rb

@@ -69,6 +69,22 @@ class TestDataView < TypeArrayTestCase
     assert str.frozen?
   end
 
+  def test_marshal
+    buf = ArrayBuffer.new(4)
+
+    view = DataView.new(buf)
+    view.set_int8(1, 5)
+    view.set_int16(3, 7)
+
+    serialized = "\x04\bu:\rDataView\t\x00\x05\x00\a"
+    assert_equal serialized, Marshal.dump(view)
+
+    view = Marshal.load(serialized)
+    assert_instance_of DataView, view
+    assert_equal 5, view.get_int8(1)
+    assert_equal 7, view.get_int8(3)
+  end
+
   def test_int8
     buf = ArrayBuffer.new(100)
 

data/test/test_type_array.rb

@@ -89,7 +89,7 @@ class TestTypeArray < TypeArrayTestCase
 
     ary2 = Int8Array.new(ary)
     assert_equal 100, ary2[0]
-    assert_equal -56, ary2[1]
+    assert_equal(-56, ary2[1])
     assert_equal 44, ary2[2]
   end
 
@@ -163,6 +163,9 @@ class TestTypeArray < TypeArrayTestCase
 
     assert_equal 8, ary.mul(0,1)
     assert_equal 32, ary.mul(1, 2)
+
+    ary.mul(0, 1, 3)
+    assert_equal 8, ary[3]
   end
 
   def test_plus
@@ -175,6 +178,9 @@ class TestTypeArray < TypeArrayTestCase
 
     assert_equal 6, ary.plus(0,1)
     assert_equal 12, ary.plus(1, 2)
+
+    ary.plus(1, 2, 3)
+    assert_equal 12, ary[3]
   end
 
   def test_minus
@@ -187,6 +193,9 @@ class TestTypeArray < TypeArrayTestCase
 
     assert_equal 2, ary.minus(1,0)
     assert_equal 4, ary.minus(2, 1)
+
+    ary.minus(2, 1, 3)
+    assert_equal 4, ary[3]
   end
 
   def test_div
@@ -199,6 +208,9 @@ class TestTypeArray < TypeArrayTestCase
 
     assert_equal 2, ary.div(1,0)
     assert_equal 2, ary.div(2, 1)
+
+    ary.div(2, 1, 3)
+    assert_equal 2, ary[3]
   end
 
   def test_eql
@@ -225,4 +237,38 @@ class TestTypeArray < TypeArrayTestCase
     assert ary.eql(0,1)
     assert !ary.eql(1,2)
   end
+
+  def test_each
+    buf = ArrayBuffer.new(16)
+
+    ary = Int32Array.new(buf)
+    ary[0] = 2
+    ary[1] = 4
+    ary[2] = 8
+    ary[3] = 16
+
+    vals = []
+    assert_equal ary, ary.each{|v| vals << v }
+
+    assert_equal [2, 4, 8, 16], vals
+    assert_equal %w(2 4 8 16), ary.map(&:to_s)
+  end
+
+  def test_marshal
+    buf = ArrayBuffer.new(16)
+
+    ary = Int32Array.new(buf)
+    ary[0] = 2
+    ary[1] = 4
+    ary[2] = 8
+    ary[3] = 16
+
+    serialized = "\x04\bu:\x0FInt32Array\x15\x00\x00\x00\x02\x00\x00\x00\x04\x00\x00\x00\b\x00\x00\x00\x10"
+    assert_equal serialized, Marshal.dump(ary)
+
+    ary = Marshal.load(serialized)
+    assert_instance_of Int32Array, ary
+    assert_equal 2, ary[0]
+    assert_equal 16, ary[3]
+  end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: type_array
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - "Lourens Naud\xC3\xA9"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-12 00:00:00 Z
+date: 2012-07-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake-compiler
@@ -49,6 +49,8 @@ files:
 - Gemfile.lock
 - README.rdoc
 - Rakefile
+- bench/get_set.rb
+- bench/operators.rb
 - ext/type_array/array_buffer.c
 - ext/type_array/array_buffer.h
 - ext/type_array/data_view.c
@@ -65,6 +67,7 @@ files:
 - ext/type_array/type_array_ext.h
 - lib/type_array.rb
 - lib/type_array/io.rb
+- lib/type_array/marshal.rb
 - lib/type_array/version.rb
 - test/helper.rb
 - test/test_array_buffer.rb
@@ -108,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Typed Arrays for Ruby