Class: CABlock

Inherits:
CAStride show all
Defined in:
yard-stubs/ruby_carray.rb,
yard-stubs/ca_obj_block.rb

Overview

DOCUMENTATION ONLY — DO NOT REQUIRE. Stubs for CABlock accessors and address helpers defined in ext/ca_obj_block.c. The CABlock class shell lives in yard-stubs/ruby_carray.rb. See yard-stubs/README.md and yard-stubs/STYLE.md.

Constant Summary

Constants inherited from CArray

CArray::HAVE_COMPLEX, CArray::LAZY_BINCMP_OP_IDS, CArray::LAZY_BINCMP_TOL_OP_IDS, CArray::LAZY_BINOP_OP_IDS, CArray::LAZY_MONOP_OP_IDS, CArray::LAZY_TRIOP_OP_IDS, CArray::UNSPECIFIED, CArray::VERSION

Block geometry collapse

Address mapping collapse

Methods inherited from CArray

#%, #/, #<=>, #==, #T, #[], #[]=, _scan_float, _scan_int, addr2index, #addr2index, #address, align_addr, align_nearest_addr, #all, #all_masked?, #ancestors, #any, #any_masked?, #as_boolean, #as_byte, #as_cmplx128, #as_cmplx256, #as_cmplx64, #as_complex, #as_dcomplex, #as_double, #as_fixlen, #as_float, #as_float128, #as_float32, #as_float64, #as_int, #as_int16, #as_int32, #as_int64, #as_int8, #as_object, #as_short, #as_strided, #as_type, #as_uint16, #as_uint32, #as_uint64, #as_uint8, attach, #attach, #attach!, attach!, #attached?, #attr, #attrs, #axis2addr, #axis_group, big_endian?, #bin, #bin_to, #bincount, #bincount_nd, #bitarray, #bitfield, #bits, #block_view, #blocks, #boolean, boolean, #boolean?, #broadcast_to, #bsearch, #bsearch_addr, byte, #byte, #bytes, cast, #cast_with, #categorize, #choose, #clip, #clip_int16, #clip_int32, #clip_int64, #clip_int8, #clip_uint16, #clip_uint32, #clip_uint64, #clip_uint8, #cmplx128, cmplx128, cmplx64, #cmplx64, #coerce, #collect!, #collect_addr!, #collect_index!, #collect_with_addr!, #collect_with_index!, complex, #complex, #complex?, #concatenate, concatenate, #conditional, const_string, #convert, #copy, #count_masked, #count_not_masked, #crop, #data_class, #data_class=, #data_type, data_type_code, #data_type_name, data_type_name, #dcomplex, dcomplex, #delete_block, #diagonal, #difference, #dim, #dim0, #dim1, #dim2, #dim3, #dim_view, #div, #div!, #divmod, double, #double, #drop_axis, dump, #dump_binary, #each, #each_addr, #each_index, each_index, #each_slab, #each_with_addr, #each_with_index, #elem_copy, #elem_decr, #elem_fetch, #elem_incr, #elem_mask, #elem_masked?, #elem_max, #elem_min, #elem_store, #elem_swap, #elem_unmask, #elements, #empty?, endian, #endian, #entity?, #eql?, #face?, #fake, #false, #farray, #field, #fields, #fields_at, #fill, #fill_copy, #first, fixlen, #fixlen, #fixlen?, fixlen_string, #flags, #flatten, #flip, float, #float, #float32, float32, #float64, float64, #float?, #fmod, #fmod!, #format, format, #frac, #freeze, from_bit_string, #from_bit_string, from_memory_view, fuse, #gather_nd, #grid, #group_by_category, #group_by_run, guard_undef, guess_type_and_bytes, #has_attr?, #has_data_class?, #has_mask?, #hash, #histogram, #histogram1d, #histogram2d, #imag, #imag=, #index, index2addr, #index2addr, #indices, #inherit_mask, #inherit_mask_replace, #initialize, #initialize_copy, #insert_axis, #insert_block, #inspect, #int, int, #int16, int16, #int32, int32, #int64, int64, #int8, int8, #integer?, #intersection, #invert_mask, #is_in, #is_masked, #is_mode, #is_not_masked, #is_real, jit_each, jit_for, jit_map, #join, #last, #lazy, #length, #linear_fetch, #linear_section, little_endian?, load, load_arrow_tensor, #load_binary, #locate_addr, #locate_nearest_addr, #lookup, #map!, #map_addr!, #map_index!, #map_slab, #map_with_addr!, #map_with_index!, #marshal_dump, #marshal_load, #mask, #mask=, #mask_array?, #mask_duplicates, #mask_eq, #mask_invalid, #mask_where, #median, meld, #meld, #members, memory_view_available?, memory_view_reject_reason, meshgrid, #mod, #mod!, #mode, montage, mosaic, #ndim, #none, #normalize_axes, normalize_axis, #normalize_axis, #normalize_index, #numeric?, #nunique, #obj_type, object, #object, #object?, #order, #pack_bits, #parent, #partition, #partition_copy, #paste, #percentile, #project, promote_list, #put_nd, #quantile, #random, #random!, #randomn, #randomn!, #rank, #read_only?, #real, #real=, #real?, #reduce_slab, #refer, #replace_where, #reshape, #resize, result_type, #roll, #root_array, #round, #same_shape?, save, #save_arrow_tensor, #scalar?, #scale, #scale!, #scatter_add!, #scatter_max!, #scatter_min!, #scatter_mul!, #scatter_replace!, #scatter_sub!, #search, #search_addr, #search_nearest, #search_nearest_addr, select, #seq, #seq!, #set_attr, #set_read_only_flag, #shape, #shift, short, #short, #shuffle, #shuffle!, #size, sizeof, #sliding_windows, #snap, #snap_to, #sort, sort_addr, #sort_addr, #sort_copy, #source_code, #span, #span!, #split, #st, stack, #stack, string, #strip_mask, struct, #swap_bytes, tabulate, #template, #then_else, #tile, time, #time, time_range, time_series, #timedelta, #to_a, #to_bit_string, #to_ca, #to_s, #to_type, #transpose, #true, uint16, #uint16, uint32, #uint32, uint64, #uint64, uint8, #uint8, #unfold, #union, union, #unique, #unmask, #valid_addr?, #valid_index?, #validity_bits, #value, #value_array?, #value_counts, #virtual?, #where, #window, #windows, wrap, wrap_memory_view, wrap_readonly, wrap_writable

Methods included from CArray::DataTypeExtension

#arange, #empty, #eye, #full, #identity, #linspace, #ones, #zeros

Constructor Details

This class inherits a constructor from CArray

Instance Method Details

#addr2addr0(addr) ⇒ Integer

Flat-address variant of #idx2addr0. Unravels the block-local flat addr into a multi-dim index, then maps that to the parent's flat address.

Parameters:

  • addr (Integer) —

    block-local flat address (0...self.elements).

Returns:

  • (Integer) 


70
 
# File 'yard-stubs/ca_obj_block.rb', line 70

def addr2addr0(addr); end

#count ⇒ Array<Integer>

Returns the per-axis number of elements the block exposes. Same as shape.

Returns:



33
 
# File 'yard-stubs/ca_obj_block.rb', line 33

def count; end

#idx2addr0(*idx) ⇒ Integer

Maps a per-axis view index tuple to the corresponding flat address into the parent (= "addr0"). Useful for projecting a view-local coordinate back onto the parent's buffer.

Parameters:

  • idx (Array<Integer>) —

    one Integer per axis; idx.length == self.ndim is required.

Returns:

  • (Integer)

Raises:

  • (ArgumentError) —

    when the number of args does not equal self.ndim.

  • (IndexError) —

    when any idx[k] is out of range for the block's shape[k].



57
 
# File 'yard-stubs/ca_obj_block.rb', line 57

def idx2addr0(*idx); end

#index2addr0(*idx) ⇒ Object

Alias of #idx2addr0.



61
 
# File 'yard-stubs/ca_obj_block.rb', line 61

def index2addr0(*idx); end

#offset ⇒ Integer

Returns the block's base flat offset into the parent (in element units), set at construction and adjusted as start moves.

Returns:

  • (Integer) 


40
 
# File 'yard-stubs/ca_obj_block.rb', line 40

def offset; end

#size0 ⇒ Array<Integer>

Returns the parent dimension sizes that the block is carved from (one Integer per axis). Distinct from shape, which is the block's own shape (= count after step / stride logic).

Returns:



15
 
# File 'yard-stubs/ca_obj_block.rb', line 15

def size0; end

#start ⇒ Array<Integer>

Returns the starting index of the block within the parent, per axis.

Returns:



21
 
# File 'yard-stubs/ca_obj_block.rb', line 21

def start; end

#step ⇒ Array<Integer>

Returns the per-axis step (stride in parent index units) the block walks the parent with.

Returns:



27
 
# File 'yard-stubs/ca_obj_block.rb', line 27

def step; end