carray 1.3.6 → 1.5.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (315) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +32 -0
  3. data/LICENSE +22 -0
  4. data/NEWS.md +65 -0
  5. data/README.md +23 -26
  6. data/Rakefile +31 -0
  7. data/TODO.md +17 -0
  8. data/carray.gemspec +24 -31
  9. data/{ca_iter_block.c → ext/ca_iter_block.c} +16 -18
  10. data/{ca_iter_dimension.c → ext/ca_iter_dimension.c} +20 -21
  11. data/{ca_iter_window.c → ext/ca_iter_window.c} +12 -14
  12. data/{ca_obj_array.c → ext/ca_obj_array.c} +451 -176
  13. data/{ca_obj_bitarray.c → ext/ca_obj_bitarray.c} +18 -23
  14. data/{ca_obj_bitfield.c → ext/ca_obj_bitfield.c} +12 -16
  15. data/{ca_obj_block.c → ext/ca_obj_block.c} +47 -54
  16. data/{ca_obj_fake.c → ext/ca_obj_fake.c} +10 -12
  17. data/{ca_obj_farray.c → ext/ca_obj_farray.c} +21 -23
  18. data/{ca_obj_field.c → ext/ca_obj_field.c} +30 -32
  19. data/{ca_obj_grid.c → ext/ca_obj_grid.c} +32 -33
  20. data/{ca_obj_mapping.c → ext/ca_obj_mapping.c} +11 -13
  21. data/{ca_obj_object.c → ext/ca_obj_object.c} +40 -42
  22. data/{ca_obj_reduce.c → ext/ca_obj_reduce.c} +3 -5
  23. data/{ca_obj_refer.c → ext/ca_obj_refer.c} +38 -40
  24. data/{ca_obj_repeat.c → ext/ca_obj_repeat.c} +45 -47
  25. data/{ca_obj_select.c → ext/ca_obj_select.c} +4 -6
  26. data/{ca_obj_shift.c → ext/ca_obj_shift.c} +26 -28
  27. data/{ca_obj_transpose.c → ext/ca_obj_transpose.c} +26 -28
  28. data/{ca_obj_unbound_repeat.c → ext/ca_obj_unbound_repeat.c} +106 -160
  29. data/{ca_obj_window.c → ext/ca_obj_window.c} +33 -35
  30. data/{carray.h → ext/carray.h} +90 -59
  31. data/{carray_access.c → ext/carray_access.c} +244 -109
  32. data/{carray_attribute.c → ext/carray_attribute.c} +161 -207
  33. data/{carray_call_cfunc.c → ext/carray_call_cfunc.c} +1 -3
  34. data/{carray_cast.c → ext/carray_cast.c} +350 -149
  35. data/{carray_cast_func.rb → ext/carray_cast_func.rb} +1 -2
  36. data/{carray_class.c → ext/carray_class.c} +28 -36
  37. data/{carray_conversion.c → ext/carray_conversion.c} +58 -70
  38. data/{carray_copy.c → ext/carray_copy.c} +34 -50
  39. data/{carray_core.c → ext/carray_core.c} +75 -62
  40. data/ext/carray_data_type.c +66 -0
  41. data/{carray_element.c → ext/carray_element.c} +34 -53
  42. data/{carray_generate.c → ext/carray_generate.c} +137 -50
  43. data/{carray_iterator.c → ext/carray_iterator.c} +53 -53
  44. data/{carray_loop.c → ext/carray_loop.c} +77 -106
  45. data/{carray_mask.c → ext/carray_mask.c} +95 -114
  46. data/{carray_math.rb → ext/carray_math.rb} +47 -31
  47. data/ext/{mathfunc/carray_mathfunc.c → carray_mathfunc.c} +1 -3
  48. data/{carray_numeric.c → ext/carray_numeric.c} +43 -46
  49. data/{carray_operator.c → ext/carray_operator.c} +72 -36
  50. data/{carray_order.c → ext/carray_order.c} +73 -217
  51. data/{carray_sort_addr.c → ext/carray_sort_addr.c} +14 -21
  52. data/{carray_stat.c → ext/carray_stat.c} +6 -8
  53. data/{carray_stat_proc.rb → ext/carray_stat_proc.rb} +25 -27
  54. data/{carray_test.c → ext/carray_test.c} +59 -51
  55. data/{carray_undef.c → ext/carray_undef.c} +1 -11
  56. data/{carray_utils.c → ext/carray_utils.c} +12 -4
  57. data/{extconf.rb → ext/extconf.rb} +1 -6
  58. data/{mkmath.rb → ext/mkmath.rb} +13 -3
  59. data/{ruby_carray.c → ext/ruby_carray.c} +20 -8
  60. data/{ruby_ccomplex.c → ext/ruby_ccomplex.c} +1 -3
  61. data/{ruby_float_func.c → ext/ruby_float_func.c} +1 -3
  62. data/ext/version.h +16 -0
  63. data/{version.rb → ext/version.rb} +0 -0
  64. data/lib/carray.rb +52 -10
  65. data/lib/carray/{base/autoload.rb → autoload.rb} +48 -8
  66. data/lib/carray/autoload/autoload_base.rb +1 -5
  67. data/lib/carray/autoload/autoload_gem_cairo.rb +9 -0
  68. data/lib/carray/autoload/autoload_gem_ffi.rb +9 -0
  69. data/lib/carray/autoload/autoload_gem_gnuplot.rb +2 -0
  70. data/lib/carray/autoload/autoload_gem_io_csv.rb +14 -0
  71. data/lib/carray/autoload/autoload_gem_io_pg.rb +6 -0
  72. data/lib/carray/autoload/autoload_gem_io_sqlite3.rb +12 -0
  73. data/lib/carray/autoload/autoload_gem_narray.rb +10 -0
  74. data/lib/carray/autoload/autoload_gem_numo_narray.rb +15 -0
  75. data/lib/carray/autoload/autoload_gem_opencv.rb +16 -0
  76. data/lib/carray/autoload/autoload_gem_random.rb +8 -0
  77. data/lib/carray/autoload/autoload_gem_rmagick.rb +23 -0
  78. data/lib/carray/autoload/{autoload_graphics_zimg.rb → autoload_gem_zimg.rb} +0 -0
  79. data/lib/carray/basic.rb +191 -0
  80. data/lib/carray/broadcast.rb +82 -0
  81. data/lib/carray/compose.rb +315 -0
  82. data/lib/carray/construct.rb +460 -0
  83. data/lib/carray/convert.rb +115 -0
  84. data/lib/carray/info.rb +1 -3
  85. data/lib/carray/{base/inspect.rb → inspect.rb} +9 -11
  86. data/lib/carray/io/imagemagick.rb +2 -4
  87. data/lib/carray/{base/iterator.rb → iterator.rb} +6 -6
  88. data/lib/carray/mask.rb +102 -0
  89. data/lib/carray/{base/math.rb → math.rb} +21 -53
  90. data/lib/carray/math/histogram.rb +8 -10
  91. data/lib/carray/math/recurrence.rb +1 -3
  92. data/lib/carray/mkmf.rb +9 -3
  93. data/lib/carray/object/ca_obj_iterator.rb +1 -3
  94. data/lib/carray/object/ca_obj_link.rb +1 -3
  95. data/lib/carray/object/ca_obj_pack.rb +9 -11
  96. data/lib/carray/obsolete.rb +270 -0
  97. data/lib/carray/ordering.rb +181 -0
  98. data/lib/carray/{base/serialize.rb → serialize.rb} +50 -66
  99. data/lib/carray/string.rb +188 -0
  100. data/lib/carray/{base/struct.rb → struct.rb} +19 -21
  101. data/lib/carray/{io/table.rb → table.rb} +1 -9
  102. data/lib/carray/testing.rb +51 -0
  103. data/lib/carray/time.rb +76 -0
  104. data/lib/carray/transform.rb +98 -0
  105. data/misc/Methods.ja.md +182 -0
  106. data/{NOTE → misc/NOTE} +0 -0
  107. data/spec/Classes/CABitfield_spec.rb +58 -0
  108. data/spec/Classes/CABlockIterator_spec.rb +114 -0
  109. data/spec/Classes/CABlock_spec.rb +205 -0
  110. data/spec/Classes/CAField_spec.rb +39 -0
  111. data/spec/Classes/CAGrid_spec.rb +75 -0
  112. data/spec/Classes/CAMap_spec.rb +0 -0
  113. data/{test/test_CAMapping.rb → spec/Classes/CAMapping_spec.rb} +35 -36
  114. data/spec/Classes/CAObject_attribute_spec.rb +33 -0
  115. data/spec/Classes/CAObject_spec.rb +33 -0
  116. data/spec/Classes/CARefer_spec.rb +93 -0
  117. data/spec/Classes/CARepeat_spec.rb +65 -0
  118. data/spec/Classes/CASelect_spec.rb +22 -0
  119. data/spec/Classes/CAShift_spec.rb +16 -0
  120. data/spec/Classes/CAStruct_spec.rb +71 -0
  121. data/{test/test_CATranspose.rb → spec/Classes/CATranspose_spec.rb} +20 -21
  122. data/spec/Classes/CAUnboudRepeat_spec.rb +102 -0
  123. data/spec/Classes/CAWindow_spec.rb +54 -0
  124. data/spec/Classes/CAWrap_spec.rb +8 -0
  125. data/{test/test_CArray.rb → spec/Classes/CArray_spec.rb} +48 -92
  126. data/spec/Classes/CScalar_spec.rb +55 -0
  127. data/spec/Features/feature_130_spec.rb +19 -0
  128. data/spec/Features/feature_attributes_spec.rb +280 -0
  129. data/spec/Features/feature_boolean_spec.rb +98 -0
  130. data/spec/Features/feature_broadcast.rb +116 -0
  131. data/spec/Features/feature_cast_function.rb +19 -0
  132. data/spec/Features/feature_cast_spec.rb +33 -0
  133. data/spec/Features/feature_class_spec.rb +84 -0
  134. data/spec/Features/feature_complex_spec.rb +42 -0
  135. data/{test/test_composite.rb → spec/Features/feature_composite_spec.rb} +17 -18
  136. data/spec/Features/feature_convert_spec.rb +46 -0
  137. data/spec/Features/feature_copy_spec.rb +123 -0
  138. data/spec/Features/feature_creation_spec.rb +84 -0
  139. data/spec/Features/feature_element_spec.rb +144 -0
  140. data/spec/Features/feature_extream_spec.rb +54 -0
  141. data/spec/Features/feature_generate_spec.rb +74 -0
  142. data/spec/Features/feature_index_spec.rb +69 -0
  143. data/spec/Features/feature_mask_spec.rb +580 -0
  144. data/spec/Features/feature_math_spec.rb +97 -0
  145. data/spec/Features/feature_order_spec.rb +146 -0
  146. data/spec/Features/feature_ref_store_spec.rb +209 -0
  147. data/spec/Features/feature_serialization_spec.rb +125 -0
  148. data/spec/Features/feature_stat_spec.rb +397 -0
  149. data/spec/Features/feature_virtual_spec.rb +48 -0
  150. data/spec/Features/method_eq_spec.rb +81 -0
  151. data/spec/Features/method_is_nan_spec.rb +12 -0
  152. data/spec/Features/method_map_spec.rb +54 -0
  153. data/spec/Features/method_max_with.rb +20 -0
  154. data/spec/Features/method_min_with.rb +19 -0
  155. data/spec/Features/method_ne_spec.rb +18 -0
  156. data/spec/Features/method_project_spec.rb +188 -0
  157. data/spec/Features/method_ref_spec.rb +27 -0
  158. data/spec/Features/method_round_spec.rb +11 -0
  159. data/spec/Features/method_s_linspace_spec.rb +48 -0
  160. data/spec/Features/method_s_span_spec.rb +14 -0
  161. data/spec/Features/method_seq_spec.rb +47 -0
  162. data/spec/Features/method_sort_with.rb +43 -0
  163. data/spec/Features/method_sorted_with.rb +29 -0
  164. data/spec/Features/method_span_spec.rb +42 -0
  165. data/spec/Features/method_wrap_readonly_spec.rb +43 -0
  166. data/{test → spec/UnitTest}/test_CAVirtual.rb +0 -0
  167. data/spec/spec_all.rb +0 -1
  168. data/utils/convert_test.rb +73 -0
  169. data/utils/{extract_rdoc.rb → extract_yard.rb} +7 -12
  170. data/{devel → utils}/guess_shape.rb +0 -0
  171. data/utils/{diff_method.rb → monkey_patch_methods.rb} +17 -7
  172. metadata +173 -316
  173. data/COPYING +0 -56
  174. data/GPL +0 -340
  175. data/Gemfile +0 -8
  176. data/Gemfile.lock +0 -33
  177. data/LEGAL +0 -50
  178. data/Makefile +0 -451
  179. data/TODO +0 -5
  180. data/carray_cast_func.c +0 -8670
  181. data/carray_config.h +0 -26
  182. data/carray_math.c +0 -24805
  183. data/carray_random.c +0 -531
  184. data/carray_stat_proc.c +0 -12170
  185. data/ext/calculus/carray_calculus.c +0 -931
  186. data/ext/calculus/carray_interp.c +0 -358
  187. data/ext/calculus/extconf.rb +0 -12
  188. data/ext/calculus/lib/autoload/autoload_math_calculus.rb +0 -2
  189. data/ext/calculus/lib/math/calculus.rb +0 -119
  190. data/ext/calculus/lib/math/interp/adapter_interp1d.rb +0 -31
  191. data/ext/fortio/extconf.rb +0 -3
  192. data/ext/fortio/lib/carray/autoload/autoload_fortran_format.rb +0 -5
  193. data/ext/fortio/lib/carray/io/fortran_format.rb +0 -43
  194. data/ext/fortio/lib/fortio.rb +0 -3
  195. data/ext/fortio/lib/fortio/fortran_format.rb +0 -605
  196. data/ext/fortio/lib/fortio/fortran_format.tab.rb +0 -536
  197. data/ext/fortio/lib/fortio/fortran_format.y +0 -215
  198. data/ext/fortio/lib/fortio/fortran_namelist.rb +0 -151
  199. data/ext/fortio/lib/fortio/fortran_namelist.tab.rb +0 -470
  200. data/ext/fortio/lib/fortio/fortran_namelist.y +0 -213
  201. data/ext/fortio/lib/fortio/fortran_sequential.rb +0 -345
  202. data/ext/fortio/ruby_fortio.c +0 -182
  203. data/ext/fortio/test/test_H.rb +0 -5
  204. data/ext/fortio/test/test_T.rb +0 -7
  205. data/ext/fortio/test/test_fortran_format.rb +0 -86
  206. data/ext/fortio/test/test_namelist.rb +0 -25
  207. data/ext/fortio/test/test_namelist_write.rb +0 -10
  208. data/ext/fortio/test/test_sequential.rb +0 -13
  209. data/ext/fortio/test/test_sequential2.rb +0 -13
  210. data/ext/fortio/work/test.rb +0 -10
  211. data/ext/fortio/work/test_e.rb +0 -19
  212. data/ext/fortio/work/test_ep.rb +0 -10
  213. data/ext/fortio/work/test_parse.rb +0 -12
  214. data/ext/imagemap/carray_imagemap.c +0 -495
  215. data/ext/imagemap/doc/call_graph.dot +0 -28
  216. data/ext/imagemap/draw.c +0 -567
  217. data/ext/imagemap/extconf.rb +0 -13
  218. data/ext/imagemap/lib/autoload/autoload_graphics_imagemap.rb +0 -1
  219. data/ext/imagemap/lib/graphics/imagemap.rb +0 -273
  220. data/ext/imagemap/lib/image_map.rb +0 -4
  221. data/ext/imagemap/test/swath_index.rb +0 -83
  222. data/ext/imagemap/test/swath_warp.rb +0 -99
  223. data/ext/imagemap/test/test.rb +0 -23
  224. data/ext/imagemap/test/test_image.rb +0 -42
  225. data/ext/imagemap/test/test_line.rb +0 -14
  226. data/ext/imagemap/test/test_rotate.rb +0 -17
  227. data/ext/imagemap/test/test_triangle.rb +0 -20
  228. data/ext/imagemap/test/test_warp.rb +0 -26
  229. data/ext/mathfunc/extconf.rb +0 -18
  230. data/ext/mathfunc/lib/autoload/autoload_math_mathfunc.rb +0 -1
  231. data/ext/mathfunc/lib/math/mathfunc.rb +0 -15
  232. data/ext/mathfunc/test/test_hypot.rb +0 -5
  233. data/ext/mathfunc/test/test_j0.rb +0 -22
  234. data/ext/mathfunc/test/test_jn.rb +0 -8
  235. data/ext/mathfunc/test/test_sph.rb +0 -9
  236. data/ext/narray/README +0 -22
  237. data/ext/narray/ca_wrap_narray.c +0 -500
  238. data/ext/narray/carray_narray.c +0 -21
  239. data/ext/narray/extconf.rb +0 -57
  240. data/ext/narray/lib/autoload/autoload_math_narray.rb +0 -1
  241. data/ext/narray/lib/autoload/autoload_math_narray_miss.rb +0 -11
  242. data/ext/narray/lib/math/narray.rb +0 -17
  243. data/ext/narray/lib/math/narray_miss.rb +0 -45
  244. data/lib/carray/autoload/autoload_graphics_gnuplot.rb +0 -2
  245. data/lib/carray/autoload/autoload_io_csv.rb +0 -14
  246. data/lib/carray/autoload/autoload_io_pg.rb +0 -6
  247. data/lib/carray/autoload/autoload_io_sqlite3.rb +0 -12
  248. data/lib/carray/autoload/autoload_io_table.rb +0 -1
  249. data/lib/carray/autoload/autoload_math_interp.rb +0 -4
  250. data/lib/carray/base/basic.rb +0 -1090
  251. data/lib/carray/base/obsolete.rb +0 -131
  252. data/lib/carray/graphics/gnuplot.rb +0 -2131
  253. data/lib/carray/graphics/zimg.rb +0 -296
  254. data/lib/carray/io/csv.rb +0 -572
  255. data/lib/carray/io/pg.rb +0 -101
  256. data/lib/carray/io/sqlite3.rb +0 -215
  257. data/lib/carray/math/interp.rb +0 -57
  258. data/lib/carray/math/interp/adapter_gsl_spline.rb +0 -47
  259. data/mkmf.log +0 -375
  260. data/mt19937ar.c +0 -182
  261. data/mt19937ar.h +0 -86
  262. data/rdoc_ext.rb +0 -1115
  263. data/rdoc_main.rb +0 -27
  264. data/rdoc_math.rb +0 -5
  265. data/rdoc_stat.rb +0 -31
  266. data/spec/CABlockIterator/CABlockIterator_spec.rb +0 -113
  267. data/spec/CArray/bug/store_spec.rb +0 -27
  268. data/spec/CArray/index/repeat_spec.rb +0 -10
  269. data/spec/CArray/method/eq_spec.rb +0 -80
  270. data/spec/CArray/method/is_nan_spec.rb +0 -12
  271. data/spec/CArray/method/ne_spec.rb +0 -18
  272. data/spec/CArray/method/round_spec.rb +0 -11
  273. data/spec/CArray/object/_attribute_spec.rb +0 -32
  274. data/spec/CArray/object/s_new_spec.rb +0 -31
  275. data/spec/CArray/serialize/Serialization_spec.rb +0 -89
  276. data/test/test_130.rb +0 -23
  277. data/test/test_ALL.rb +0 -51
  278. data/test/test_CABitfield.rb +0 -59
  279. data/test/test_CABlock.rb +0 -208
  280. data/test/test_CAField.rb +0 -40
  281. data/test/test_CAGrid.rb +0 -76
  282. data/test/test_CAMmap.rb +0 -11
  283. data/test/test_CARefer.rb +0 -94
  284. data/test/test_CARepeat.rb +0 -66
  285. data/test/test_CASelect.rb +0 -23
  286. data/test/test_CAShift.rb +0 -17
  287. data/test/test_CAWindow.rb +0 -55
  288. data/test/test_CAWrap.rb +0 -9
  289. data/test/test_CComplex.rb +0 -83
  290. data/test/test_CScalar.rb +0 -91
  291. data/test/test_attribute.rb +0 -281
  292. data/test/test_block_iterator.rb +0 -17
  293. data/test/test_boolean.rb +0 -99
  294. data/test/test_cast.rb +0 -33
  295. data/test/test_class.rb +0 -85
  296. data/test/test_complex.rb +0 -43
  297. data/test/test_convert.rb +0 -79
  298. data/test/test_copy.rb +0 -141
  299. data/test/test_creation.rb +0 -85
  300. data/test/test_element.rb +0 -146
  301. data/test/test_extream.rb +0 -55
  302. data/test/test_generate.rb +0 -75
  303. data/test/test_index.rb +0 -71
  304. data/test/test_mask.rb +0 -578
  305. data/test/test_math.rb +0 -98
  306. data/test/test_narray.rb +0 -64
  307. data/test/test_order.rb +0 -147
  308. data/test/test_random.rb +0 -15
  309. data/test/test_ref_store.rb +0 -211
  310. data/test/test_stat.rb +0 -414
  311. data/test/test_struct.rb +0 -72
  312. data/test/test_virtual.rb +0 -49
  313. data/utils/create_rdoc.sh +0 -9
  314. data/utils/make_tgz.sh +0 -3
  315. data/version.h +0 -18
@@ -161,8 +161,7 @@ puts %{
161
161
  the Ruby\'s licence.
162
162
 
163
163
  This file is automatically generated from carray_math.rb.
164
-
165
- Copyright (C) 2005 Hiroki Motoyoshi
164
+ Copyright (C) 2005-2020 Hiroki Motoyoshi
166
165
 
167
166
  ---------------------------------------------------------------------------- */
168
167
 
@@ -3,22 +3,19 @@
3
3
  carray_class.c
4
4
 
5
5
  This file is part of Ruby/CArray extension library.
6
- You can redistribute it and/or modify it under the terms of
7
- the Ruby Licence.
8
6
 
9
- Copyright (C) 2005 Hiroki Motoyoshi
7
+ Copyright (C) 2005-2020 Hiroki Motoyoshi
10
8
 
11
9
  ---------------------------------------------------------------------------- */
12
10
 
13
11
  #include "carray.h"
14
12
 
15
- /* rdoc:
16
- # returns the machine endianness.
17
- # CArray.endian #=> 0 (CA_LITTLE_ENDIAN)
18
- # CArray.endian #=> 1 (CA_BIG_ENDIAN)
13
+ /* @overload endian
19
14
 
20
- def CArray.endian
21
- end
15
+ (Inquiry)
16
+ Returns the machine endianness.
17
+ 0 (CA_LITTLE_ENDIAN)
18
+ 1 (CA_BIG_ENDIAN)
22
19
  */
23
20
 
24
21
  static VALUE
@@ -27,12 +24,10 @@ rb_ca_s_endian (VALUE klass)
27
24
  return INT2NUM(ca_endian);
28
25
  }
29
26
 
30
- /* rdoc:
31
- # returns true if the byte order of the architecture is
32
- # big endian.
33
-
34
- def CArray.big_endian?
35
- end
27
+ /* @overload big_endian?
28
+
29
+ (Inquiry)
30
+ Returns true if the byte order of the architecture is big endian.
36
31
  */
37
32
 
38
33
  static VALUE
@@ -41,12 +36,11 @@ rb_ca_s_big_endian_p (VALUE klass)
41
36
  return ( ca_endian == CA_BIG_ENDIAN ) ? Qtrue : Qfalse;
42
37
  }
43
38
 
44
- /* rdoc:
45
- # returns true if the byte order of the architecture is
46
- # little endian.
39
+ /* @overload little_endian?
47
40
 
48
- def CArray.little_endian?
49
- end
41
+ (Inquiry)
42
+ Returns true if the byte order of the architecture is
43
+ little endian.
50
44
  */
51
45
 
52
46
  static VALUE
@@ -55,15 +49,15 @@ rb_ca_s_little_endian_p (VALUE klass)
55
49
  return ( ca_endian == CA_LITTLE_ENDIAN ) ? Qtrue : Qfalse;
56
50
  }
57
51
 
58
- /* rdoc:
59
- # Returns the byte length of an element of the given data type.
60
- # Retruns <code>0</code> if data_type is equal to CA_FIXLEN.
61
- # CArray.sizeof(CA_INT32) #=> 4
62
- # CArray.sizeof(CA_DOUBLE) #=> 8
63
- # CArray.sizeof(CA_FIXLEN) #=> 0
52
+ /* @overload sizeof (data_type)
53
+
54
+ (Inquiry)
55
+ Returns the byte length of an element of the given data type.
56
+ Retruns <code>0</code> if data_type is equal to CA_FIXLEN.
57
+ CArray.sizeof(CA_INT32) #=> 4
58
+ CArray.sizeof(CA_DOUBLE) #=> 8
59
+ CArray.sizeof(CA_FIXLEN) #=> 0
64
60
 
65
- def CArray.sizeof (data_type)
66
- end
67
61
  */
68
62
 
69
63
  static VALUE
@@ -76,11 +70,10 @@ rb_ca_s_sizeof (VALUE klass, VALUE rtype)
76
70
  }
77
71
 
78
72
 
79
- /* rdoc:
80
- # Returns true if the given data_type indicate the valid data_type.
73
+ /* @overload data_type?(data_type)
81
74
 
82
- def CArray.data_type?(data_type)
83
- end
75
+ (Inquiry)
76
+ Returns true if the given data_type indicate the valid data_type.
84
77
  */
85
78
 
86
79
  static VALUE
@@ -94,11 +87,10 @@ rb_ca_s_data_type (VALUE klass, VALUE rtype)
94
87
  return ca_valid[data_type] == 1 ? Qtrue : Qfalse;
95
88
  }
96
89
 
97
- /* rdoc:
98
- # Returns string representaion of the data_type specifier.
90
+ /* @overload data_type_name(data_type)
99
91
 
100
- def CArray.data_type_name(data_type)
101
- end
92
+ (Inquiry)
93
+ Returns string representaion of the data_type specifier.
102
94
  */
103
95
 
104
96
 
@@ -3,10 +3,8 @@
3
3
  carray_conversion.c
4
4
 
5
5
  This file is part of Ruby/CArray extension library.
6
- You can redistribute it and/or modify it under the terms of
7
- the Ruby Licence.
8
6
 
9
- Copyright (C) 2005 Hiroki Motoyoshi
7
+ Copyright (C) 2005-2020 Hiroki Motoyoshi
10
8
 
11
9
  ---------------------------------------------------------------------------- */
12
10
 
@@ -27,7 +25,7 @@ rb_ca_to_a_loop (VALUE self, int32_t level, ca_size_t *idx, VALUE ary)
27
25
 
28
26
  Data_Get_Struct(self, CArray, ca);
29
27
 
30
- if ( level == ca->rank - 1 ) {
28
+ if ( level == ca->ndim - 1 ) {
31
29
  for (i=0; i<ca->dim[level]; i++) {
32
30
  idx[level] = i;
33
31
  rb_ary_store(ary, i, rb_ca_fetch_index(self, idx));
@@ -43,13 +41,12 @@ rb_ca_to_a_loop (VALUE self, int32_t level, ca_size_t *idx, VALUE ary)
43
41
  }
44
42
  }
45
43
 
46
- /* rdoc:
47
- class CArray
48
- # Converts the array to Ruby's array. For higher dimension,
49
- # the array is nested rank-1 times.
50
- def to_a
51
- end
52
- end
44
+ /*
45
+ @overload to_a
46
+
47
+ (Conversion)
48
+ Converts the array to Ruby's array. For higher dimension,
49
+ the array is nested ndim-1 times.
53
50
  */
54
51
 
55
52
  VALUE
@@ -66,13 +63,12 @@ rb_ca_to_a (VALUE self)
66
63
  return ary;
67
64
  }
68
65
 
69
- /* rdoc:
70
- class CArray
71
- # Convert the
72
- def convert (data_type=nil, dim=nil)
73
- yield
74
- end
75
- end
66
+ /* @overload convert (data_type=nil, dim=nil) { |elem| ... }
67
+
68
+ (Conversion)
69
+ Returns new array which elements are caluculated
70
+ in the iteration block. The output array is internally created
71
+ using `CArray#template` to which the arguments is passed.
76
72
  */
77
73
 
78
74
  static VALUE
@@ -106,12 +102,10 @@ rb_ca_convert (int argc, VALUE *argv, VALUE self)
106
102
  return obj;
107
103
  }
108
104
 
109
- /* rdoc:
110
- class CArray
111
- # dumps the value array to the given IO stream
112
- def dump_binary(io)
113
- end
114
- end
105
+ /* @overload dump_binary
106
+
107
+ (IO)
108
+ Dumps the value array to the given IO stream
115
109
  */
116
110
 
117
111
  static VALUE
@@ -149,7 +143,6 @@ rb_ca_dump_binary (int argc, VALUE *argv, VALUE self)
149
143
  case T_FILE: {
150
144
  volatile VALUE str;
151
145
  rb_io_t *iop;
152
- rb_secure(4);
153
146
  GetOpenFile(io, iop);
154
147
  rb_io_check_writable(iop);
155
148
  ca_attach(ca);
@@ -162,7 +155,6 @@ rb_ca_dump_binary (int argc, VALUE *argv, VALUE self)
162
155
  case T_FILE: {
163
156
  OpenFile *iop;
164
157
  size_t total;
165
- rb_secure(4);
166
158
  GetOpenFile(io, iop);
167
159
  rb_io_check_writable(iop);
168
160
  ca_attach(ca);
@@ -189,19 +181,10 @@ rb_ca_dump_binary (int argc, VALUE *argv, VALUE self)
189
181
  return io;
190
182
  }
191
183
 
192
- static VALUE
193
- rb_ca_dump (int argc, VALUE *argv, VALUE self)
194
- {
195
- rb_warn("CArray#dump will be obsolete, use CArray#dump_binary");
196
- return rb_ca_dump_binary(argc, argv, self);
197
- }
184
+ /* @overload to_s
198
185
 
199
- /* rdoc:
200
- class CArray
201
- # dumps the value array to a string.
202
- def to_s
203
- end
204
- end
186
+ (Conversion)
187
+ Dumps the value array to a string.
205
188
  */
206
189
 
207
190
  static VALUE
@@ -210,12 +193,10 @@ rb_ca_to_s (VALUE self)
210
193
  return rb_ca_dump_binary(0, NULL, self);
211
194
  }
212
195
 
213
- /* rdoc:
214
- class CArray
215
- # loads the value array from the given IO stream
216
- def load_binary (io)
217
- end
218
- end
196
+ /* @overload load_binary (io)
197
+
198
+ (IO)
199
+ Loads the value array from the given IO stream
219
200
  */
220
201
 
221
202
  static VALUE
@@ -258,13 +239,6 @@ rb_ca_load_binary (VALUE self, VALUE io)
258
239
  return self;
259
240
  }
260
241
 
261
- static VALUE
262
- rb_ca_load (VALUE self, VALUE io)
263
- {
264
- rb_warn("CArray#load will be obsolete, use CArray#load_binary");
265
- return rb_ca_load_binary(self, io);
266
- }
267
-
268
242
  void *
269
243
  ca_to_cptr (void *ap)
270
244
  {
@@ -280,14 +254,14 @@ ca_to_cptr (void *ap)
280
254
  rb_raise(rb_eRuntimeError, "[BUG] ca_to_cptr called for detached array");
281
255
  }
282
256
 
283
- if ( ca->rank == 1 ) {
284
- rb_raise(rb_eRuntimeError, "[BUG] ca_to_cptr called for rank-1 array");
257
+ if ( ca->ndim == 1 ) {
258
+ rb_raise(rb_eRuntimeError, "[BUG] ca_to_cptr called for ndim-1 array");
285
259
  }
286
260
 
287
261
  offset[0] = 0;
288
262
  count[0] = ca->dim[0];
289
263
  ptr_num = count[0];
290
- for (i=1; i<ca->rank-1; i++) {
264
+ for (i=1; i<ca->ndim-1; i++) {
291
265
  offset[i] = ptr_num;
292
266
  count[i] = count[i-1] * ca->dim[i];
293
267
  ptr_num += count[i];
@@ -295,15 +269,15 @@ ca_to_cptr (void *ap)
295
269
 
296
270
  ptr = malloc(sizeof(void*)*ptr_num);
297
271
 
298
- i = ca->rank-2;
272
+ i = ca->ndim-2;
299
273
  p = ptr + offset[i];
300
274
  q = (char *)ca->ptr;
301
275
  for (j=0; j<count[i]; j++) {
302
276
  *p = (void*)q;
303
- p++; q += ca->dim[ca->rank-1] * ca->bytes;
277
+ p++; q += ca->dim[ca->ndim-1] * ca->bytes;
304
278
  }
305
279
 
306
- for (i=ca->rank-3; i>=0; i--) {
280
+ for (i=ca->ndim-3; i>=0; i--) {
307
281
  p = ptr + offset[i];
308
282
  r = ptr + offset[i+1];
309
283
  for (j=0; j<count[i]; j++) {
@@ -316,13 +290,11 @@ ca_to_cptr (void *ap)
316
290
  }
317
291
 
318
292
 
319
- /* rdoc:
320
- class CArray
321
- # Convert the
322
- def convert (data_type=nil, dim=nil)
323
- yield
324
- end
325
- end
293
+ /* @overload str_format (*fmts)
294
+
295
+ (Conversion)
296
+ Creates object type array consist of string using the "::format" method.
297
+ The Multiple format strings are given, they are applied cyclic in turn.
326
298
  */
327
299
 
328
300
 
@@ -368,9 +340,15 @@ rb_ca_format (int argc, VALUE *argv, VALUE self)
368
340
  }
369
341
 
370
342
 
371
-
372
343
  #include <time.h>
373
344
 
345
+ /* @overload str_strptime (fmt)
346
+
347
+ (Conversion)
348
+ Creates object type array consist of Time objects
349
+ which are created by 'Time.strptime' applied to the elements of the object.
350
+ This method assumes all the elements of the objetct to be String.
351
+ */
374
352
 
375
353
  static VALUE
376
354
  rb_ca_strptime (VALUE self, VALUE rfmt)
@@ -387,6 +365,7 @@ rb_ca_strptime (VALUE self, VALUE rfmt)
387
365
  rb_raise(rb_eRuntimeError, "strptime can be applied only to object type.");
388
366
  }
389
367
 
368
+ Check_Type(rfmt, T_STRING);
390
369
  fmt = (char *) StringValuePtr(rfmt);
391
370
 
392
371
  obj = rb_ca_template(self);
@@ -425,6 +404,13 @@ rb_ca_strptime (VALUE self, VALUE rfmt)
425
404
  return obj;
426
405
  }
427
406
 
407
+ /* @overload time_strptime (fmt)
408
+
409
+ (Conversion)
410
+ Creates object type array consist of strings
411
+ which are created by 'Time#strftime' applied to the elements of the object.
412
+ This method assumes all the elements of the objetct to be Time or DateTime.
413
+ */
428
414
 
429
415
  static VALUE
430
416
  rb_ca_strftime (VALUE self, VALUE rfmt)
@@ -465,6 +451,10 @@ rb_ca_strftime (VALUE self, VALUE rfmt)
465
451
  return obj;
466
452
  }
467
453
 
454
+ /* @private
455
+
456
+ */
457
+
468
458
  static VALUE
469
459
  rb_test_ca_to_cptr (VALUE self)
470
460
  {
@@ -499,19 +489,17 @@ Init_carray_conversion ()
499
489
  rb_define_method(rb_cCArray, "to_a", rb_ca_to_a, 0);
500
490
  rb_define_method(rb_cCArray, "convert", rb_ca_convert, -1);
501
491
 
502
- rb_define_method(rb_cCArray, "dump", rb_ca_dump, -1);
503
492
  rb_define_method(rb_cCArray, "dump_binary", rb_ca_dump_binary, -1);
504
493
  rb_define_method(rb_cCArray, "to_s", rb_ca_to_s, 0);
505
- rb_define_method(rb_cCArray, "load", rb_ca_load, 1);
506
494
  rb_define_method(rb_cCArray, "load_binary", rb_ca_load_binary, 1);
507
495
 
508
496
  /* DO NOT define CArray#to_ary, it makes trouble with various situations */
509
497
  /* rb_define_method(rb_cCArray, "to_ary", rb_ca_to_a, 0); */
510
498
 
511
- rb_define_method(rb_cCArray, "frmt", rb_ca_format, -1);
499
+ rb_define_method(rb_cCArray, "str_format", rb_ca_format, -1);
512
500
 
513
- rb_define_method(rb_cCArray, "strptime", rb_ca_strptime, 1);
514
- rb_define_method(rb_cCArray, "strftime", rb_ca_strftime, 1);
501
+ rb_define_method(rb_cCArray, "str_strptime", rb_ca_strptime, 1);
502
+ rb_define_method(rb_cCArray, "time_strftime", rb_ca_strftime, 1);
515
503
 
516
504
  rb_define_method(rb_cCArray, "test_ca_to_cptr", rb_test_ca_to_cptr, 0);
517
505
 
@@ -3,10 +3,8 @@
3
3
  carray_copy.c
4
4
 
5
5
  This file is part of Ruby/CArray extension library.
6
- You can redistribute it and/or modify it under the terms of
7
- the Ruby Licence.
8
6
 
9
- Copyright (C) 2005 Hiroki Motoyoshi
7
+ Copyright (C) 2005-2020 Hiroki Motoyoshi
10
8
 
11
9
  ---------------------------------------------------------------------------- */
12
10
 
@@ -25,7 +23,7 @@ ca_copy (void *ap)
25
23
  co = (CArray *) cscalar_new(ca->data_type, ca->bytes, 0);
26
24
  }
27
25
  else { /* create array without mask */
28
- co = carray_new(ca->data_type, ca->rank, ca->dim, ca->bytes, 0);
26
+ co = carray_new(ca->data_type, ca->ndim, ca->dim, ca->bytes, 0);
29
27
  }
30
28
 
31
29
  if ( ca_is_attached(ca) ) {
@@ -43,12 +41,9 @@ ca_copy (void *ap)
43
41
  return co;
44
42
  }
45
43
 
46
- /* rdoc:
47
- class CArray
48
- # create CArray object from `self` with same contents includes mask state.
49
- def to_ca
50
- end
51
- end
44
+ /* @overload to_ca
45
+
46
+ (Copy) Creates CArray object from `self` with same contents includes mask state.
52
47
  */
53
48
 
54
49
  VALUE
@@ -72,7 +67,7 @@ ca_template (void *ap)
72
67
  return (CArray*) cscalar_new(ca->data_type, ca->bytes, NULL);
73
68
  }
74
69
  else { /* create array without mask */
75
- return carray_new(ca->data_type, ca->rank, ca->dim, ca->bytes, NULL);
70
+ return carray_new(ca->data_type, ca->ndim, ca->dim, ca->bytes, NULL);
76
71
  }
77
72
  }
78
73
 
@@ -84,7 +79,7 @@ ca_template_safe (void *ap)
84
79
  return (CArray*) cscalar_new(ca->data_type, ca->bytes, NULL);
85
80
  }
86
81
  else { /* create array filled with 0, without mask */
87
- return carray_new_safe(ca->data_type, ca->rank, ca->dim, ca->bytes, NULL);
82
+ return carray_new_safe(ca->data_type, ca->ndim, ca->dim, ca->bytes, NULL);
88
83
  }
89
84
  }
90
85
 
@@ -97,19 +92,16 @@ ca_template_safe2 (void *ap, int8_t data_type, ca_size_t bytes)
97
92
  return (CArray*) cscalar_new(data_type, bytes, NULL);
98
93
  }
99
94
  else { /* create array filled with 0, without mask */
100
- return carray_new_safe(data_type, ca->rank, ca->dim, bytes, NULL);
95
+ return carray_new_safe(data_type, ca->ndim, ca->dim, bytes, NULL);
101
96
  }
102
97
  }
103
98
 
104
- /* rdoc:
105
- class CArray
106
- # returns CArray object with same dimension with `self`
107
- # The data type of the new carray object can be specified by `data_type`.
108
- # For fixlen data type, the option `:bytes` is used to specified the
109
- # data length.
110
- def template(data_type=self.data_type, options={:bytes=>0})
111
- end
112
- end
99
+ /* @overload template(data_type=self.data_type, bytes: 0)
100
+
101
+ (Copy) Returns CArray object with same dimension with `self`
102
+ The data type of the new carray object can be specified by `data_type`.
103
+ For fixlen data type, the option `:bytes` is used to specified the
104
+ data length.
113
105
  */
114
106
 
115
107
  static VALUE
@@ -209,7 +201,7 @@ ca_paste_loop (CArray *ca, ca_size_t *offset, ca_size_t *offset0,
209
201
  int32_t level, ca_size_t *idx, ca_size_t *idx0)
210
202
  {
211
203
  ca_size_t i;
212
- if ( level == ca->rank - 1 ) {
204
+ if ( level == ca->ndim - 1 ) {
213
205
  idx[level] = offset[level];
214
206
  idx0[level] = offset0[level];
215
207
  memcpy(ca_ptr_at_index(ca, idx), ca_ptr_at_index(cs, idx0), size[level]*ca->bytes);
@@ -240,9 +232,9 @@ ca_paste (void *ap, ca_size_t *offset, void *sp)
240
232
  int8_t i;
241
233
 
242
234
  ca_check_same_data_type(ca, cs);
243
- ca_check_same_rank(ca, cs);
235
+ ca_check_same_ndim(ca, cs);
244
236
 
245
- for (i=0; i<ca->rank; i++) {
237
+ for (i=0; i<ca->ndim; i++) {
246
238
  if ( offset[i] >= 0 ) {
247
239
  if ( ca->dim[i] <= cs->dim[i] + offset[i] ) {
248
240
  size[i] = ca->dim[i] - offset[i];
@@ -264,7 +256,7 @@ ca_paste (void *ap, ca_size_t *offset, void *sp)
264
256
  }
265
257
  }
266
258
 
267
- for (i=0; i<ca->rank; i++) {
259
+ for (i=0; i<ca->ndim; i++) {
268
260
  CA_CHECK_INDEX(offset[i], ca->dim[i]);
269
261
  }
270
262
 
@@ -284,14 +276,10 @@ ca_paste (void *ap, ca_size_t *offset, void *sp)
284
276
  ca_detach_n(2, ca, cs);
285
277
  }
286
278
 
287
- /* rdoc:
288
- class CArray
289
- # pastes `ary` to `self` at the index `idx`.
290
- # `idx` should be Array object with the length same as `self.rank`.
291
- # `ary` should have same shape with `self`.
292
- def paste (idx, ary)
293
- end
294
- end
279
+ /* @overload paste (idx, ary)
280
+ (Copy) Pastes `ary` to `self` at the index `idx`.
281
+ `idx` should be Array object with the length same as `self.ndim`.
282
+ `ary` should have same shape with `self`.
295
283
  */
296
284
 
297
285
  static VALUE
@@ -307,12 +295,12 @@ rb_ca_paste (VALUE self, VALUE roffset, VALUE rsrc)
307
295
 
308
296
  Check_Type(roffset, T_ARRAY);
309
297
 
310
- if ( RARRAY_LEN(roffset) != ca->rank ) {
298
+ if ( RARRAY_LEN(roffset) != ca->ndim ) {
311
299
  rb_raise(rb_eArgError,
312
- "# of arguments should equal to the rank");
300
+ "# of arguments should equal to the ndim");
313
301
  }
314
302
 
315
- for (i=0; i<ca->rank; i++) {
303
+ for (i=0; i<ca->ndim; i++) {
316
304
  offset[i] = NUM2SIZE(rb_ary_entry(roffset,i));
317
305
  }
318
306
 
@@ -330,7 +318,7 @@ ca_clip_loop (CArray *ca, ca_size_t *offset, ca_size_t *offset0,
330
318
  int32_t level, ca_size_t *idx, ca_size_t *idx0)
331
319
  {
332
320
  ca_size_t i;
333
- if ( level == ca->rank - 1 ) {
321
+ if ( level == ca->ndim - 1 ) {
334
322
  idx[level] = offset[level];
335
323
  idx0[level] = offset0[level];
336
324
  memcpy(ca_ptr_at_index(cs, idx0), ca_ptr_at_index(ca, idx), size[level]*ca->bytes);
@@ -358,9 +346,9 @@ ca_clip (void *ap, ca_size_t *offset, void *sp)
358
346
  int i;
359
347
 
360
348
  ca_check_same_data_type(ca, cs);
361
- ca_check_same_rank(ca, cs);
349
+ ca_check_same_ndim(ca, cs);
362
350
 
363
- for (i=0; i<ca->rank; i++) {
351
+ for (i=0; i<ca->ndim; i++) {
364
352
  if ( offset[i] >= 0 ) {
365
353
  if ( ca->dim[i] <= cs->dim[i] + offset[i] ) {
366
354
  size[i] = ca->dim[i] - offset[i];
@@ -382,7 +370,7 @@ ca_clip (void *ap, ca_size_t *offset, void *sp)
382
370
  }
383
371
  }
384
372
 
385
- for (i=0; i<ca->rank; i++) {
373
+ for (i=0; i<ca->ndim; i++) {
386
374
  CA_CHECK_INDEX(offset[i], ca->dim[i]);
387
375
  }
388
376
 
@@ -402,12 +390,8 @@ ca_clip (void *ap, ca_size_t *offset, void *sp)
402
390
  ca_detach_n(2, ca, cs);
403
391
  }
404
392
 
405
- /* rdoc:
406
- class CArray
407
- # clips the data at `idx` from `self` to `ary`.
408
- def clip (idx, ary)
409
- end
410
- end
393
+ /* @overload clip (idx, ary)
394
+ (copy) Clips the data at `idx` from `self` to `ary`.
411
395
  */
412
396
 
413
397
  static VALUE
@@ -421,12 +405,12 @@ rb_ca_clip (VALUE self, VALUE roffset, VALUE rsrc)
421
405
 
422
406
  Check_Type(roffset, T_ARRAY);
423
407
 
424
- if ( RARRAY_LEN(roffset) != ca->rank ) {
408
+ if ( RARRAY_LEN(roffset) != ca->ndim ) {
425
409
  rb_raise(rb_eArgError,
426
- "# of arguments should equal to the rank");
410
+ "# of arguments should equal to the ndim");
427
411
  }
428
412
 
429
- for (i=0; i<ca->rank; i++) {
413
+ for (i=0; i<ca->ndim; i++) {
430
414
  offset[i] = NUM2SIZE(rb_ary_entry(roffset, i));
431
415
  }
432
416