mirror of
https://github.com/ruby/ruby.git
synced 2025-08-15 13:39:04 +02:00
The Ruby Programming Language
https://www.ruby-lang.org/
e4f85bfc31
Set has been an autoloaded standard library since Ruby 3.2. The standard library Set is less efficient than it could be, as it uses Hash for storage, which stores unnecessary values for each key. Implementation details: * Core Set uses a modified version of `st_table`, named `set_table`. than `s/st_/set_/`, the main difference is that the stored records do not have values, making them 1/3 smaller. `st_table_entry` stores `hash`, `key`, and `record` (value), while `set_table_entry` only stores `hash` and `key`. This results in large sets using ~33% less memory compared to stdlib Set. For small sets, core Set uses 12% more memory (160 byte object slot and 64 malloc bytes, while stdlib set uses 40 for Set and 160 for Hash). More memory is used because the set_table is embedded and 72 bytes in the object slot are currently wasted. Hopefully we can make this more efficient and have it stored in an 80 byte object slot in the future. * All methods are implemented as cfuncs, except the pretty_print methods, which were moved to `lib/pp.rb` (which is where the pretty_print methods for other core classes are defined). As is typical for core classes, internal calls call C functions and not Ruby methods. For example, to check if something is a Set, `rb_obj_is_kind_of` is used, instead of calling `is_a?(Set)` on the related object. * Almost all methods use the same algorithm that the pure-Ruby implementation used. The exception is when calling `Set#divide` with a block with 2-arity. The pure-Ruby method used tsort to implement this. I developed an algorithm that only allocates a single intermediate hash and does not need tsort. * The `flatten_merge` protected method is no longer necessary, so it is not implemented (it could be). * Similar to Hash/Array, subclasses of Set are no longer reflected in `inspect` output. * RDoc from stdlib Set was moved to core Set, with minor updates. This includes a comprehensive benchmark suite for all public Set methods. As you would expect, the native version is faster in the vast majority of cases, and multiple times faster in many cases. There are a few cases where it is significantly slower: * Set.new with no arguments (~1.6x) * Set#compare_by_identity for small sets (~1.3x) * Set#clone for small sets (~1.5x) * Set#dup for small sets (~1.7x) These are slower as Set does not currently use the AR table optimization that Hash does, so a new set_table is initialized for each call. I'm not sure it's worth the complexity to have an AR table-like optimization for small sets (for hashes it makes sense, as small hashes are used everywhere in Ruby). The rbs and repl_type_completor bundled gems will need updates to support core Set. The pull request marks them as allowed failures. This passes all set tests with no changes. The following specs needed modification: * Modifying frozen set error message (changed for the better) * `Set#divide` when passed a 2-arity block no longer yields the same object as both the first and second argument (this seems like an issue with the previous implementation). * Set-like objects that override `is_a?` such that `is_a?(Set)` return `true` are no longer treated as Set instances. * `Set.allocate.hash` is no longer the same as `nil.hash` * `Set#join` no longer calls `Set#to_a` (it calls the underlying C function). * `Set#flatten_merge` protected method is not implemented. Previously, `set.rb` added a `SortedSet` autoload, which loads `set/sorted_set.rb`. This replaces the `Set` autoload in `prelude.rb` with a `SortedSet` autoload, but I recommend removing it and `set/sorted_set.rb`. This moves `test/set/test_set.rb` to `test/ruby/test_set.rb`, reflecting that switch to a core class. This does not move the spec files, as I'm not sure how they should be handled. Internally, this uses the st_* types and functions as much as possible, and only adds set_* types and functions as needed. The underlying set_table implementation is stored in st.c, but there is no public C-API for it, nor is there one planned, in order to keep the ability to change the internals going forward. For internal uses of st_table with Qtrue values, those can probably be replaced with set_table. To do that, include internal/set_table.h. To handle symbol visibility (rb_ prefix), internal/set_table.h uses the same macro approach that include/ruby/st.h uses. The Set class (rb_cSet) and all methods are defined in set.c. There isn't currently a C-API for the Set class, though C-API functions can be added as needed going forward. Implements [Feature #21216] Co-authored-by: Jean Boussier <jean.boussier@gmail.com> Co-authored-by: Oliver Nutter <mrnoname1000@riseup.net> |
||
|---|---|---|
| .github | ||
| basictest | ||
| benchmark | ||
| bin | ||
| bootstraptest | ||
| ccan | ||
| coroutine | ||
| coverage | ||
| cygwin | ||
| defs | ||
| doc | ||
| enc | ||
| ext | ||
| gc | ||
| gems | ||
| include | ||
| internal | ||
| lib | ||
| libexec | ||
| man | ||
| misc | ||
| missing | ||
| prism | ||
| sample | ||
| spec | ||
| template | ||
| test | ||
| tool | ||
| wasm | ||
| win32 | ||
| yjit | ||
| zjit | ||
| .dir-locals.el | ||
| .document | ||
| .editorconfig | ||
| .gdbinit | ||
| .git-blame-ignore-revs | ||
| .gitattributes | ||
| .gitignore | ||
| .indent.pro | ||
| .mailmap | ||
| .rdoc_options | ||
| .rspec_parallel | ||
| .travis.yml | ||
| aclocal.m4 | ||
| addr2line.c | ||
| addr2line.h | ||
| array.c | ||
| array.rb | ||
| ast.c | ||
| ast.rb | ||
| autogen.sh | ||
| bignum.c | ||
| BSDL | ||
| builtin.c | ||
| builtin.h | ||
| class.c | ||
| common.mk | ||
| compar.c | ||
| compile.c | ||
| complex.c | ||
| configure.ac | ||
| constant.h | ||
| cont.c | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| COPYING.ja | ||
| darray.h | ||
| debug.c | ||
| debug_counter.c | ||
| debug_counter.h | ||
| dir.c | ||
| dir.rb | ||
| dln.c | ||
| dln.h | ||
| dln_find.c | ||
| dmydln.c | ||
| dmyenc.c | ||
| dmyext.c | ||
| encindex.h | ||
| encoding.c | ||
| enum.c | ||
| enumerator.c | ||
| error.c | ||
| eval.c | ||
| eval_error.c | ||
| eval_intern.h | ||
| eval_jump.c | ||
| file.c | ||
| gc.c | ||
| gc.rb | ||
| gem_prelude.rb | ||
| golf_prelude.rb | ||
| goruby.c | ||
| GPL | ||
| hash.c | ||
| hash.rb | ||
| hrtime.h | ||
| id_table.c | ||
| id_table.h | ||
| imemo.c | ||
| inits.c | ||
| insns.def | ||
| internal.h | ||
| io.c | ||
| io.rb | ||
| io_buffer.c | ||
| iseq.c | ||
| iseq.h | ||
| kernel.rb | ||
| KNOWNBUGS.rb | ||
| LEGAL | ||
| lex.c.blt | ||
| load.c | ||
| loadpath.c | ||
| localeinit.c | ||
| main.c | ||
| marshal.c | ||
| marshal.rb | ||
| math.c | ||
| memory_view.c | ||
| method.h | ||
| mini_builtin.c | ||
| miniinit.c | ||
| NEWS.md | ||
| nilclass.rb | ||
| node.c | ||
| node.h | ||
| node_dump.c | ||
| numeric.c | ||
| numeric.rb | ||
| object.c | ||
| pack.c | ||
| pack.rb | ||
| parse.y | ||
| parser_bits.h | ||
| parser_node.h | ||
| parser_st.c | ||
| parser_st.h | ||
| parser_value.h | ||
| prelude.rb | ||
| prism_compile.c | ||
| prism_compile.h | ||
| prism_init.c | ||
| probes.d | ||
| probes_helper.h | ||
| proc.c | ||
| process.c | ||
| ractor.c | ||
| ractor.rb | ||
| ractor_core.h | ||
| random.c | ||
| range.c | ||
| rational.c | ||
| re.c | ||
| README.EXT | ||
| README.EXT.ja | ||
| README.ja.md | ||
| README.md | ||
| regcomp.c | ||
| regenc.c | ||
| regenc.h | ||
| regerror.c | ||
| regexec.c | ||
| regint.h | ||
| regparse.c | ||
| regparse.h | ||
| regsyntax.c | ||
| ruby-runner.c | ||
| ruby.c | ||
| ruby_assert.h | ||
| ruby_atomic.h | ||
| ruby_parser.c | ||
| rubyparser.h | ||
| rubystub.c | ||
| scheduler.c | ||
| set.c | ||
| shape.c | ||
| shape.h | ||
| signal.c | ||
| siphash.c | ||
| siphash.h | ||
| sparc.c | ||
| sprintf.c | ||
| st.c | ||
| strftime.c | ||
| string.c | ||
| string.rb | ||
| struct.c | ||
| symbol.c | ||
| symbol.h | ||
| symbol.rb | ||
| thread.c | ||
| thread_none.c | ||
| thread_none.h | ||
| thread_pthread.c | ||
| thread_pthread.h | ||
| thread_pthread_mn.c | ||
| thread_sync.c | ||
| thread_sync.rb | ||
| thread_win32.c | ||
| thread_win32.h | ||
| time.c | ||
| timev.h | ||
| timev.rb | ||
| trace_point.rb | ||
| transcode.c | ||
| transcode_data.h | ||
| universal_parser.c | ||
| util.c | ||
| variable.c | ||
| variable.h | ||
| vcpkg.json | ||
| version.c | ||
| version.h | ||
| vm.c | ||
| vm_args.c | ||
| vm_backtrace.c | ||
| vm_callinfo.h | ||
| vm_core.h | ||
| vm_debug.h | ||
| vm_dump.c | ||
| vm_eval.c | ||
| vm_exec.c | ||
| vm_exec.h | ||
| vm_insnhelper.c | ||
| vm_insnhelper.h | ||
| vm_method.c | ||
| vm_opts.h | ||
| vm_sync.c | ||
| vm_sync.h | ||
| vm_trace.c | ||
| vsnprintf.c | ||
| warning.rb | ||
| weakmap.c | ||
| yjit.c | ||
| yjit.h | ||
| yjit.rb | ||
| yjit_hook.rb | ||
| zjit.c | ||
| zjit.h | ||
| zjit.rb | ||
What is Ruby?
Ruby is an interpreted object-oriented programming language often used for web development. It also offers many scripting features to process plain text and serialized files, or manage system tasks. It is simple, straightforward, and extensible.
Features of Ruby
- Simple Syntax
- Normal Object-oriented Features (e.g. class, method calls)
- Advanced Object-oriented Features (e.g. mix-in, singleton-method)
- Operator Overloading
- Exception Handling
- Iterators and Closures
- Garbage Collection
- Dynamic Loading of Object Files (on some architectures)
- Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, macOS, etc.) cf. https://docs.ruby-lang.org/en/master/maintainers_md.html#label-Platform+Maintainers
How to get Ruby
For a complete list of ways to install Ruby, including using third-party tools like rvm, see:
https://www.ruby-lang.org/en/downloads/
You can download release packages and the snapshot of the repository. If you want to download whole versions of Ruby, please visit https://www.ruby-lang.org/en/downloads/releases/.
Download with Git
The mirror of the Ruby source tree can be checked out with the following command:
$ git clone https://github.com/ruby/ruby.git
There are some other branches under development. Try the following command to see the list of branches:
$ git ls-remote https://github.com/ruby/ruby.git
You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source) if you are a committer.
How to build
See Building Ruby
Ruby home page
Documentation
Mailing list
There is a mailing list to discuss Ruby. To subscribe to this list, please send the following phrase:
join
in the mail subject (not body) to the address ruby-talk-request@ml.ruby-lang.org.
Copying
See the file COPYING.
Feedback
Questions about the Ruby language can be asked on the Ruby-Talk mailing list or on websites like https://stackoverflow.com.
Bugs should be reported at https://bugs.ruby-lang.org. Read "Reporting Issues" for more information.
Contributing
See "Contributing to Ruby", which includes setup and build instructions.
The Author
Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.