carray 3.0.0 → 3.0.2

data/yard-stubs/ruby_carray.rb

@@ -0,0 +1,193 @@
+# DOCUMENTATION ONLY — DO NOT REQUIRE.
+# Stubs for class hierarchy and constants declared in
+# ext/ruby_carray.c. See yard-stubs/README.md and yard-stubs/STYLE.md.
+
+# Multi-dimensional numeric array.
+#
+# See `docs/Tutorial.md` for a guided tour, the per-topic guides under
+# `docs/guides/`, and the method index below for the full reference.
+class CArray < Object
+  # Library semantic version, e.g. `"3.0.0.dev"`.
+  VERSION = ""
+
+  # Sentinel marking "the caller did not give this argument", used by
+  # C entry points whose fill value may legitimately be `nil` (so `nil`
+  # itself cannot mark absence). Never pass it in.
+  # @api private
+  UNSPECIFIED = nil
+
+  # `true` when the build links `<complex.h>`; `false` otherwise.
+  # Complex array types (`:cmplx64`, `:cmplx128`) require this to be
+  # `true`.
+  HAVE_COMPLEX = nil
+
+  # Raised when a method is invoked on a CArray whose `data_type` is
+  # incompatible with the operation (e.g. binary I/O on `:object`,
+  # quickselect on `:fixlen`).
+  class DataTypeError < StandardError
+  end
+end
+
+# Untyped external-memory wrapper. Created via
+# {CArray.wrap_memory_view} for zero-copy interop with NumPy / Numo /
+# Arrow.
+class CAWrap < CArray
+end
+
+# Zero-dimensional CArray. One element, broadcasts like a scalar in
+# elementwise ops.
+class CScalar < CArray
+end
+
+# Base class of all virtual (view) CArrays. Has a `parent` and an
+# `attach` lifecycle; `entity? == false`.
+class CAView < CArray
+end
+
+# General strided view. Common base for views expressible as
+# `parent.ptr + base_offset + Σ idx[k] * strides[k]`.
+class CAStride < CAView
+end
+
+# `CArray#reshape` / `CArray#flatten` view. Also used for type or
+# byte-size reinterpretation.
+class CARefer < CAStride
+end
+
+# Rectangular slice / sub-array view (`a[r1, r2, ...]`).
+class CABlock < CAStride
+end
+
+# Member-of-fixlen view (`a.field(offset, type)`).
+class CAField < CAStride
+end
+
+# Boolean / fancy-index gather view.
+class CASelect < CAView
+end
+
+# Per-element Ruby callback bridge view.
+class CAObject < CAView
+end
+
+# Repeat-broadcast view (`a.repeat(n0, n1, ...)`).
+class CARepeat < CAStride
+end
+
+# Ragged concatenation view (`CArray.meld(*arrays, axis:)`). Welds
+# K parents along one of their existing axes with (potentially) uneven
+# segment lengths. Prefix-sum table {#seg_offsets} keeps segment
+# boundaries explicit so segment resolution stays per-segment rather
+# than per-cell.  Ruby entry: {CArray.meld} / {CArray#meld}
+# (`lib/carray/stack.rb`).
+#
+# See `docs/objects/CAMeld.md` for the user-facing overview.
+class CAMeld < CAView
+  # Returns the number of parent arrays welded by `self`.
+  # @return [Integer]
+  def n_parents; end
+
+  # Returns the parent arrays welded by `self`. The Array holds
+  # references to the constructor's inputs; identity is preserved.
+  # @return [Array<CArray>]
+  def parents; end
+
+  # Returns the axis along which the parents are welded (the
+  # ragged axis). Non-meld axes have uniform length across parents.
+  # @return [Integer] in `[0, ndim)`.
+  def meld_axis; end
+
+  # Returns the prefix-sum offsets along {#meld_axis}. Length
+  # `n_parents + 1`; `seg_offsets[k]` is the starting position of
+  # parent `k` in the view, and `seg_offsets[n_parents]` equals
+  # `shape[meld_axis]`.
+  # @return [Array<Integer>]
+  # @example
+  #   a = CArray.int32(3, 4) { 0 }
+  #   b = CArray.int32(5, 4) { 0 }
+  #   c = CArray.int32(1, 4) { 0 }
+  #   CArray.meld(a, b, c, axis: 0).seg_offsets   # => [0, 3, 8, 9]
+  def seg_offsets; end
+end
+
+# Namespace for CArray utility module functions.
+module CA
+end
+
+# --- Top-level constants (defined on Object in ext/ruby_carray.c) ---
+
+# Maximum supported `ndim`.
+CA_RANK_MAX = nil
+
+# @!group Data type symbols
+#
+# Each constant is a `Symbol` matching the canonical `data_type`
+# name. Aliases share Symbol identity with their canonical form
+# (e.g. `CA_DOUBLE == CA_FLOAT64` via Symbol equality).
+
+# `:fixlen` — fixed-length opaque byte blob; element byte size set
+# per array.
+CA_FIXLEN = :fixlen
+# `:boolean` — 8-bit boolean.
+CA_BOOLEAN = :boolean
+# `:int8` — signed 8-bit integer.
+CA_INT8 = :int8
+# `:uint8` — unsigned 8-bit integer.
+CA_UINT8 = :uint8
+# `:int16` — signed 16-bit integer.
+CA_INT16 = :int16
+# `:uint16` — unsigned 16-bit integer.
+CA_UINT16 = :uint16
+# `:int32` — signed 32-bit integer.
+CA_INT32 = :int32
+# `:uint32` — unsigned 32-bit integer.
+CA_UINT32 = :uint32
+# `:int64` — signed 64-bit integer.
+CA_INT64 = :int64
+# `:uint64` — unsigned 64-bit integer.
+CA_UINT64 = :uint64
+# `:float32` — IEEE-754 single-precision float.
+CA_FLOAT32 = :float32
+# `:float64` — IEEE-754 double-precision float.
+CA_FLOAT64 = :float64
+# `:cmplx64` — single-precision complex (two `float32` packed).
+CA_CMPLX64 = :cmplx64
+# `:cmplx128` — double-precision complex.
+CA_CMPLX128 = :cmplx128
+# `:object` — boxed Ruby object slot.
+CA_OBJECT = :object
+
+# Alias of {CA_UINT8}.
+CA_BYTE = :uint8
+# Alias of {CA_INT16}.
+CA_SHORT = :int16
+# Alias of {CA_INT32}.
+CA_INT = :int32
+# Alias of {CA_FLOAT32}.
+CA_FLOAT = :float32
+# Alias of {CA_FLOAT64}.
+CA_DOUBLE = :float64
+# Alias of {CA_CMPLX64}.
+CA_COMPLEX = :cmplx64
+# Alias of {CA_DCOMPLEX}.
+CA_DCOMPLEX = :cmplx128
+# Platform-native size type alias; resolves to `:int64` on 64-bit
+# builds and `:int32` on 32-bit builds.
+CA_SIZE = :int64
+
+# @!endgroup
+
+# Byte alignment of each element type, used by `CArray.wrap` and
+# MemoryView interop helpers. Internal, not part of the user surface.
+CA_ALIGN_VOIDP = nil # :nodoc:
+CA_ALIGN_FIXLEN = nil # :nodoc:
+CA_ALIGN_BOOLEAN = nil # :nodoc:
+CA_ALIGN_INT8 = nil # :nodoc:
+CA_ALIGN_INT16 = nil # :nodoc:
+CA_ALIGN_INT32 = nil # :nodoc:
+CA_ALIGN_INT64 = nil # :nodoc:
+CA_ALIGN_FLOAT32 = nil # :nodoc:
+CA_ALIGN_FLOAT64 = nil # :nodoc:
+CA_ALIGN_CMPLX64 = nil # :nodoc:
+CA_ALIGN_CMPLX128 = nil # :nodoc:
+CA_ALIGN_OBJECT = nil # :nodoc:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carray
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2
 platform: ruby
 authors:
 - himotoyoshi
@@ -10,11 +10,14 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |2
-      Ruby/CArray is an extension library for the multi-dimensional numerical array
-      class. The name "CArray" comes from the meaning of a wrapper to a numerical array
-      handled by the C language. CArray stores integers or floating-point numbers in
-      memory block and treats them collectively to ensure efficient performance.
-      Therefore, Ruby/CArray is suitable for numerical computation and data analysis.
+      Ruby/CArray adds multi-dimensional numerical arrays to Ruby. Elements are held
+      in a single flat memory block, so whole-array work -- element-wise arithmetic,
+      reductions along any axis, sorting, searching -- runs in C. Slicing, transposing,
+      reshaping, and selecting by a boolean condition all return views that share
+      storage with the original array and can be chained freely; nothing is copied
+      until you ask for a copy. Any array, view included, can carry a mask marking
+      individual elements as undefined, and arrays are exchanged with other numerical
+      libraries without copying through Ruby's MemoryView protocol.
 email:
 - himotoyoshi@users.noreply.github.com
 executables: []
@@ -24,8 +27,8 @@ extra_rdoc_files: []
 files:
 - ".yardopts"
 - CHANGELOG.md
+- CHANGELOG.v1.md
 - LICENSE
-- NEWS.md
 - README.md
 - carray.gemspec
 - ext/ca_array_pool.c
@@ -88,11 +91,13 @@ files:
 - ext/ca_obj_timedelta.c
 - ext/ca_obj_transpose.c
 - ext/ca_obj_triop.c
-- ext/ca_obj_unbound_repeat.c
 - ext/ca_obj_window.c
 - ext/ca_op_byte_swap.c
+- ext/ca_op_cmplx64.h
 - ext/ca_op_ipower.c
 - ext/ca_op_powi.h
+- ext/ca_rng_normal.h
+- ext/ca_rng_xoshiro256pp.h
 - ext/ca_sort_kernels.h
 - ext/ca_sweep_engine.c
 - ext/ca_sweep_engine.h
@@ -101,9 +106,11 @@ files:
 - ext/ca_triop_dispatch.h
 - ext/carray.h
 - ext/carray_access.c
+- ext/carray_address_basis.c
 - ext/carray_attribute.c
 - ext/carray_bincount.c
 - ext/carray_broadcast.c
+- ext/carray_build_flags.h
 - ext/carray_call_cfunc.c
 - ext/carray_call_cfunc.h
 - ext/carray_cast.c
@@ -182,6 +189,7 @@ files:
 - lib/carray/construct.rb
 - lib/carray/core_extensions.rb
 - lib/carray/data_type_extension.rb
+- lib/carray/data_type_limits.rb
 - lib/carray/fixlen_string.rb
 - lib/carray/frame.rb
 - lib/carray/frame/concat.rb
@@ -194,6 +202,8 @@ files:
 - lib/carray/frame/records.rb
 - lib/carray/frame/sort.rb
 - lib/carray/frame/verbs.rb
+- lib/carray/fuse_source.rb
+- lib/carray/fusion.rb
 - lib/carray/histogram.rb
 - lib/carray/inspect.rb
 - lib/carray/iterator.rb
@@ -208,6 +218,8 @@ files:
 - lib/carray/methods/broadcast.rb
 - lib/carray/methods/choose.rb
 - lib/carray/methods/composition.rb
+- lib/carray/methods/discovery_along.rb
+- lib/carray/methods/factorize.rb
 - lib/carray/methods/gather_nd.rb
 - lib/carray/methods/index.rb
 - lib/carray/methods/insert_block.rb
@@ -218,12 +230,14 @@ files:
 - lib/carray/methods/meshgrid.rb
 - lib/carray/methods/mode.rb
 - lib/carray/methods/nunique.rb
+- lib/carray/methods/repeat.rb
 - lib/carray/methods/resize.rb
 - lib/carray/methods/snap.rb
 - lib/carray/methods/string_format.rb
 - lib/carray/methods/unique.rb
 - lib/carray/methods/value_counts.rb
 - lib/carray/mkmf.rb
+- lib/carray/rng.rb
 - lib/carray/runtime.rb
 - lib/carray/serialize.rb
 - lib/carray/slab_iterator.rb
@@ -235,6 +249,49 @@ files:
 - lib/carray/table.rb
 - lib/carray/time.rb
 - lib/carray/window_iterator.rb
+- yard-stubs/ca_obj_array.rb
+- yard-stubs/ca_obj_bitarray.rb
+- yard-stubs/ca_obj_bitfield.rb
+- yard-stubs/ca_obj_block.rb
+- yard-stubs/ca_obj_byte_swap.rb
+- yard-stubs/ca_obj_fake.rb
+- yard-stubs/ca_obj_farray.rb
+- yard-stubs/ca_obj_field.rb
+- yard-stubs/ca_obj_grid.rb
+- yard-stubs/ca_obj_refer.rb
+- yard-stubs/ca_obj_roll.rb
+- yard-stubs/ca_obj_shift.rb
+- yard-stubs/ca_obj_stride.rb
+- yard-stubs/ca_obj_tile.rb
+- yard-stubs/ca_obj_transpose.rb
+- yard-stubs/ca_obj_window.rb
+- yard-stubs/carray_access.rb
+- yard-stubs/carray_attribute.rb
+- yard-stubs/carray_broadcast.rb
+- yard-stubs/carray_cast.rb
+- yard-stubs/carray_class.rb
+- yard-stubs/carray_conversion.rb
+- yard-stubs/carray_copy.rb
+- yard-stubs/carray_core.rb
+- yard-stubs/carray_count.rb
+- yard-stubs/carray_element.rb
+- yard-stubs/carray_generate.rb
+- yard-stubs/carray_lazy.rb
+- yard-stubs/carray_loop.rb
+- yard-stubs/carray_mask.rb
+- yard-stubs/carray_math.rb
+- yard-stubs/carray_mathfunc.rb
+- yard-stubs/carray_median_percentile.rb
+- yard-stubs/carray_memory_view.rb
+- yard-stubs/carray_order.rb
+- yard-stubs/carray_random.rb
+- yard-stubs/carray_scatter.rb
+- yard-stubs/carray_slab.rb
+- yard-stubs/carray_sort.rb
+- yard-stubs/carray_test.rb
+- yard-stubs/carray_undef.rb
+- yard-stubs/carray_utils.rb
+- yard-stubs/ruby_carray.rb
 homepage: https://github.com/himotoyoshi/carray
 licenses:
 - MIT
@@ -254,7 +311,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.17
 specification_version: 4
-summary: Multi-dimesional array class for Ruby
+summary: Multi-dimensional numerical array class for Ruby
 test_files: []