rbs 2.8.4 → 3.8.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/dependabot.yml +12 -4
- data/.github/workflows/comments.yml +11 -11
- data/.github/workflows/dependabot.yml +30 -0
- data/.github/workflows/ruby.yml +40 -49
- data/.github/workflows/typecheck.yml +36 -0
- data/.github/workflows/windows.yml +28 -0
- data/.gitignore +1 -0
- data/.rubocop.yml +42 -2
- data/CHANGELOG.md +845 -1
- data/README.md +64 -4
- data/Rakefile +198 -18
- data/Steepfile +11 -11
- data/config.yml +311 -0
- data/core/array.rbs +2189 -1914
- data/core/basic_object.rbs +59 -84
- data/core/binding.rbs +7 -69
- data/core/builtin.rbs +210 -11
- data/core/class.rbs +37 -0
- data/core/comparable.rbs +23 -25
- data/core/complex.rbs +449 -227
- data/core/constants.rbs +29 -21
- data/core/data.rbs +415 -0
- data/core/dir.rbs +698 -415
- data/core/encoding.rbs +468 -843
- data/core/enumerable.rbs +495 -455
- data/core/enumerator/product.rbs +92 -0
- data/core/enumerator.rbs +106 -9
- data/core/env.rbs +1 -1
- data/core/errno.rbs +506 -605
- data/core/errors.rbs +15 -17
- data/core/exception.rbs +361 -145
- data/core/false_class.rbs +39 -26
- data/core/fiber.rbs +121 -14
- data/core/file.rbs +1262 -320
- data/core/file_test.rbs +62 -45
- data/core/float.rbs +187 -208
- data/core/gc.rbs +446 -196
- data/core/global_variables.rbs +29 -29
- data/core/hash.rbs +242 -349
- data/core/integer.rbs +246 -308
- data/core/io/buffer.rbs +373 -122
- data/core/io/wait.rbs +29 -17
- data/core/io.rbs +1881 -1518
- data/core/kernel.rbs +2116 -1538
- data/core/marshal.rbs +24 -14
- data/core/match_data.rbs +413 -166
- data/core/math.rbs +531 -291
- data/core/method.rbs +101 -32
- data/core/module.rbs +228 -64
- data/core/nil_class.rbs +106 -47
- data/core/numeric.rbs +206 -292
- data/core/object.rbs +73 -1168
- data/core/object_space/weak_key_map.rbs +166 -0
- data/core/object_space.rbs +5 -3
- data/core/proc.rbs +280 -39
- data/core/process.rbs +1318 -658
- data/core/ractor.rbs +200 -134
- data/core/random.rbs +21 -4
- data/core/range.rbs +309 -153
- data/core/rational.rbs +4 -12
- data/core/rb_config.rbs +64 -43
- data/core/rbs/unnamed/argf.rbs +411 -147
- data/core/rbs/unnamed/env_class.rbs +137 -253
- data/core/rbs/unnamed/random.rbs +49 -26
- data/core/refinement.rbs +16 -1
- data/core/regexp.rbs +1568 -862
- data/core/ruby_vm.rbs +719 -7
- data/core/rubygems/config_file.rbs +3 -0
- data/core/rubygems/errors.rbs +69 -6
- data/core/rubygems/rubygems.rbs +71 -17
- data/core/rubygems/version.rbs +11 -7
- data/{stdlib/set/0 → core}/set.rbs +80 -91
- data/core/signal.rbs +14 -8
- data/core/string.rbs +1732 -1607
- data/core/struct.rbs +467 -95
- data/core/symbol.rbs +215 -245
- data/core/thread.rbs +133 -89
- data/core/thread_group.rbs +9 -9
- data/core/time.rbs +1141 -841
- data/core/trace_point.rbs +181 -121
- data/core/true_class.rbs +58 -32
- data/core/unbound_method.rbs +103 -30
- data/core/warning.rbs +50 -5
- data/docs/CONTRIBUTING.md +1 -1
- data/docs/architecture.md +110 -0
- data/docs/collection.md +59 -5
- data/docs/data_and_struct.md +86 -0
- data/docs/gem.md +57 -0
- data/docs/rbs_by_example.md +16 -35
- data/docs/repo.md +1 -1
- data/docs/sigs.md +7 -7
- data/docs/stdlib.md +63 -5
- data/docs/syntax.md +255 -61
- data/docs/tools.md +1 -0
- data/ext/rbs_extension/extconf.rb +10 -0
- data/ext/rbs_extension/lexer.c +1741 -1548
- data/ext/rbs_extension/lexer.h +11 -1
- data/ext/rbs_extension/lexer.re +12 -6
- data/ext/rbs_extension/lexstate.c +26 -3
- data/ext/rbs_extension/location.c +119 -111
- data/ext/rbs_extension/location.h +32 -7
- data/ext/rbs_extension/main.c +3 -0
- data/ext/rbs_extension/parser.c +883 -481
- data/ext/rbs_extension/parserstate.c +65 -25
- data/ext/rbs_extension/parserstate.h +13 -3
- data/ext/rbs_extension/rbs_extension.h +1 -10
- data/ext/rbs_extension/unescape.c +7 -47
- data/goodcheck.yml +2 -2
- data/{ext/rbs_extension → include/rbs}/constants.h +26 -15
- data/include/rbs/ruby_objs.h +72 -0
- data/include/rbs.h +7 -0
- data/lib/rbs/annotate/annotations.rb +3 -3
- data/lib/rbs/annotate/formatter.rb +13 -3
- data/lib/rbs/annotate/rdoc_annotator.rb +1 -1
- data/lib/rbs/annotate/rdoc_source.rb +12 -3
- data/lib/rbs/ast/declarations.rb +85 -2
- data/lib/rbs/ast/directives.rb +39 -0
- data/lib/rbs/ast/members.rb +49 -15
- data/lib/rbs/ast/type_param.rb +104 -15
- data/lib/rbs/ast/visitor.rb +137 -0
- data/lib/rbs/buffer.rb +5 -0
- data/lib/rbs/cli/colored_io.rb +48 -0
- data/lib/rbs/cli/diff.rb +83 -0
- data/lib/rbs/cli/validate.rb +356 -0
- data/lib/rbs/cli.rb +253 -143
- data/lib/rbs/collection/cleaner.rb +8 -1
- data/lib/rbs/collection/config/lockfile.rb +92 -0
- data/lib/rbs/collection/config/lockfile_generator.rb +154 -65
- data/lib/rbs/collection/config.rb +19 -46
- data/lib/rbs/collection/installer.rb +12 -13
- data/lib/rbs/collection/sources/base.rb +2 -2
- data/lib/rbs/collection/sources/git.rb +146 -69
- data/lib/rbs/collection/sources/local.rb +81 -0
- data/lib/rbs/collection/sources/rubygems.rb +10 -12
- data/lib/rbs/collection/sources/stdlib.rb +14 -13
- data/lib/rbs/collection/sources.rb +15 -2
- data/lib/rbs/collection.rb +2 -1
- data/lib/rbs/definition.rb +13 -16
- data/lib/rbs/definition_builder/ancestor_builder.rb +100 -24
- data/lib/rbs/definition_builder/method_builder.rb +4 -4
- data/lib/rbs/definition_builder.rb +489 -584
- data/lib/rbs/diff.rb +125 -0
- data/lib/rbs/environment/use_map.rb +77 -0
- data/lib/rbs/environment.rb +406 -105
- data/lib/rbs/environment_loader.rb +48 -44
- data/lib/rbs/environment_walker.rb +1 -1
- data/lib/rbs/errors.rb +175 -56
- data/lib/rbs/file_finder.rb +28 -0
- data/lib/rbs/location_aux.rb +8 -7
- data/lib/rbs/locator.rb +37 -15
- data/lib/rbs/method_type.rb +23 -0
- data/lib/rbs/namespace.rb +1 -0
- data/lib/rbs/parser/lex_result.rb +15 -0
- data/lib/rbs/parser/token.rb +23 -0
- data/lib/rbs/parser_aux.rb +22 -13
- data/lib/rbs/prototype/helpers.rb +48 -22
- data/lib/rbs/prototype/node_usage.rb +99 -0
- data/lib/rbs/prototype/rb.rb +125 -31
- data/lib/rbs/prototype/rbi.rb +49 -36
- data/lib/rbs/prototype/runtime/helpers.rb +59 -0
- data/lib/rbs/prototype/runtime/reflection.rb +19 -0
- data/lib/rbs/prototype/runtime/value_object_generator.rb +279 -0
- data/lib/rbs/prototype/runtime.rb +273 -159
- data/lib/rbs/resolver/constant_resolver.rb +24 -8
- data/lib/rbs/resolver/type_name_resolver.rb +41 -7
- data/lib/rbs/sorter.rb +153 -123
- data/lib/rbs/substitution.rb +19 -0
- data/lib/rbs/subtractor.rb +201 -0
- data/lib/rbs/test/errors.rb +24 -11
- data/lib/rbs/test/guaranteed.rb +30 -0
- data/lib/rbs/test/hook.rb +45 -40
- data/lib/rbs/test/setup.rb +1 -1
- data/lib/rbs/test/tester.rb +1 -1
- data/lib/rbs/test/type_check.rb +120 -23
- data/lib/rbs/test.rb +6 -3
- data/lib/rbs/type_alias_dependency.rb +13 -3
- data/lib/rbs/type_alias_regularity.rb +21 -14
- data/lib/rbs/type_name.rb +18 -13
- data/lib/rbs/types.rb +352 -18
- data/lib/rbs/unit_test/convertibles.rb +176 -0
- data/lib/rbs/unit_test/spy.rb +136 -0
- data/lib/rbs/unit_test/type_assertions.rb +341 -0
- data/lib/rbs/unit_test/with_aliases.rb +143 -0
- data/lib/rbs/unit_test.rb +6 -0
- data/lib/rbs/validator.rb +55 -30
- data/lib/rbs/variance_calculator.rb +26 -23
- data/lib/rbs/vendorer.rb +3 -3
- data/lib/rbs/version.rb +1 -1
- data/lib/rbs/writer.rb +69 -22
- data/lib/rbs.rb +7 -2
- data/lib/rdoc/discover.rb +1 -1
- data/lib/rdoc_plugin/parser.rb +5 -5
- data/rbs.gemspec +12 -2
- data/schema/decls.json +1 -1
- data/schema/members.json +15 -10
- data/sig/ancestor_builder.rbs +4 -0
- data/sig/ancestor_graph.rbs +22 -2
- data/sig/annotate/formatter.rbs +2 -2
- data/sig/annotate/rdoc_annotater.rbs +1 -1
- data/sig/cli/colored_io.rbs +15 -0
- data/sig/cli/diff.rbs +21 -0
- data/sig/cli/validate.rbs +43 -0
- data/sig/cli.rbs +4 -0
- data/sig/collection/config/lockfile.rbs +74 -0
- data/sig/collection/config/lockfile_generator.rbs +66 -0
- data/sig/collection/config.rbs +5 -48
- data/sig/collection/installer.rbs +1 -1
- data/sig/collection/sources.rbs +105 -33
- data/sig/constant.rbs +1 -1
- data/sig/declarations.rbs +42 -3
- data/sig/definition.rbs +26 -10
- data/sig/definition_builder.rbs +103 -81
- data/sig/diff.rbs +28 -0
- data/sig/directives.rbs +61 -0
- data/sig/environment.rbs +175 -29
- data/sig/environment_loader.rbs +20 -18
- data/sig/errors.rbs +123 -2
- data/sig/file_finder.rbs +28 -0
- data/sig/location.rbs +0 -3
- data/sig/locator.rbs +14 -2
- data/sig/manifest.yaml +0 -1
- data/sig/members.rbs +32 -9
- data/sig/method_types.rbs +10 -4
- data/sig/namespace.rbs +2 -3
- data/sig/parser.rbs +55 -16
- data/sig/prototype/helpers.rbs +4 -0
- data/sig/prototype/node_usage.rbs +20 -0
- data/sig/prototype/rb.rbs +10 -2
- data/sig/prototype/rbi.rbs +2 -0
- data/sig/prototype/runtime.rbs +182 -0
- data/sig/rbs.rbs +1 -1
- data/sig/rdoc/rbs.rbs +4 -0
- data/sig/repository.rbs +7 -5
- data/sig/resolver/constant_resolver.rbs +3 -4
- data/sig/resolver/context.rbs +1 -1
- data/sig/resolver/type_name_resolver.rbs +5 -1
- data/sig/shims/bundler.rbs +38 -0
- data/sig/shims/rubygems.rbs +19 -0
- data/sig/sorter.rbs +23 -5
- data/sig/substitution.rbs +6 -0
- data/sig/subtractor.rbs +37 -0
- data/sig/test/errors.rbs +52 -0
- data/sig/test/guranteed.rbs +9 -0
- data/sig/test/type_check.rbs +19 -0
- data/sig/test.rbs +82 -0
- data/sig/type_alias_dependency.rbs +31 -0
- data/sig/type_alias_regularity.rbs +12 -6
- data/sig/type_param.rbs +45 -9
- data/sig/typename.rbs +8 -5
- data/sig/types.rbs +119 -12
- data/sig/unit_test/convertibles.rbs +154 -0
- data/sig/unit_test/spy.rbs +28 -0
- data/sig/unit_test/type_assertions.rbs +194 -0
- data/sig/unit_test/with_aliases.rbs +136 -0
- data/sig/use_map.rbs +35 -0
- data/sig/validator.rbs +12 -5
- data/sig/variance_calculator.rbs +3 -1
- data/sig/vendorer.rbs +1 -1
- data/sig/visitor.rbs +47 -0
- data/sig/writer.rbs +6 -2
- data/src/constants.c +153 -0
- data/src/ruby_objs.c +793 -0
- data/stdlib/base64/0/base64.rbs +298 -45
- data/stdlib/benchmark/0/benchmark.rbs +12 -3
- data/stdlib/bigdecimal/0/big_decimal.rbs +62 -198
- data/stdlib/cgi/0/core.rbs +68 -15
- data/stdlib/cgi/0/manifest.yaml +1 -0
- data/stdlib/coverage/0/coverage.rbs +50 -11
- data/stdlib/csv/0/csv.rbs +90 -119
- data/stdlib/csv/0/manifest.yaml +1 -0
- data/stdlib/date/0/date.rbs +806 -735
- data/stdlib/date/0/date_time.rbs +70 -211
- data/stdlib/dbm/0/dbm.rbs +0 -2
- data/stdlib/delegate/0/delegator.rbs +184 -0
- data/stdlib/delegate/0/kernel.rbs +47 -0
- data/stdlib/delegate/0/simple_delegator.rbs +96 -0
- data/stdlib/did_you_mean/0/did_you_mean.rbs +3 -8
- data/stdlib/digest/0/digest.rbs +48 -35
- data/stdlib/erb/0/erb.rbs +15 -39
- data/stdlib/etc/0/etc.rbs +174 -54
- data/stdlib/fileutils/0/fileutils.rbs +1234 -385
- data/stdlib/forwardable/0/forwardable.rbs +4 -4
- data/stdlib/io-console/0/io-console.rbs +82 -17
- data/stdlib/ipaddr/0/ipaddr.rbs +11 -6
- data/stdlib/json/0/json.rbs +434 -151
- data/stdlib/kconv/0/kconv.rbs +166 -0
- data/stdlib/logger/0/formatter.rbs +0 -2
- data/stdlib/logger/0/log_device.rbs +1 -3
- data/stdlib/logger/0/logger.rbs +465 -328
- data/stdlib/minitest/0/kernel.rbs +2 -2
- data/stdlib/minitest/0/minitest/abstract_reporter.rbs +4 -1
- data/stdlib/minitest/0/minitest/assertion.rbs +1 -0
- data/stdlib/minitest/0/minitest/assertions.rbs +58 -13
- data/stdlib/minitest/0/minitest/backtrace_filter.rbs +7 -0
- data/stdlib/minitest/0/minitest/bench_spec.rbs +8 -8
- data/stdlib/minitest/0/minitest/benchmark.rbs +17 -16
- data/stdlib/minitest/0/minitest/compress.rbs +13 -0
- data/stdlib/minitest/0/minitest/error_on_warning.rbs +3 -0
- data/stdlib/minitest/0/minitest/mock.rbs +9 -5
- data/stdlib/minitest/0/minitest/parallel/executor.rbs +4 -0
- data/stdlib/minitest/0/minitest/parallel/test/class_methods.rbs +0 -1
- data/stdlib/minitest/0/minitest/pride_io.rbs +8 -0
- data/stdlib/minitest/0/minitest/pride_lol.rbs +2 -0
- data/stdlib/minitest/0/minitest/progress_reporter.rbs +1 -1
- data/stdlib/minitest/0/minitest/reportable.rbs +2 -0
- data/stdlib/minitest/0/minitest/runnable.rbs +33 -1
- data/stdlib/minitest/0/minitest/spec/dsl/instance_methods.rbs +1 -1
- data/stdlib/minitest/0/minitest/spec/dsl.rbs +10 -6
- data/stdlib/minitest/0/minitest/spec.rbs +1 -1
- data/stdlib/minitest/0/minitest/statistics_reporter.rbs +5 -0
- data/stdlib/minitest/0/minitest/summary_reporter.rbs +0 -7
- data/stdlib/minitest/0/minitest/test/lifecycle_hooks.rbs +7 -7
- data/stdlib/minitest/0/minitest/test.rbs +7 -14
- data/stdlib/minitest/0/minitest/unexpected_error.rbs +2 -0
- data/stdlib/minitest/0/minitest/unexpected_warning.rbs +6 -0
- data/stdlib/minitest/0/minitest/unit.rbs +1 -2
- data/stdlib/minitest/0/minitest.rbs +41 -892
- data/stdlib/monitor/0/monitor.rbs +91 -10
- data/stdlib/mutex_m/0/mutex_m.rbs +0 -2
- data/stdlib/net-http/0/manifest.yaml +1 -1
- data/stdlib/net-http/0/net-http.rbs +3858 -964
- data/stdlib/net-protocol/0/manifest.yaml +2 -0
- data/stdlib/net-protocol/0/net-protocol.rbs +56 -0
- data/stdlib/net-smtp/0/manifest.yaml +2 -0
- data/stdlib/net-smtp/0/net-smtp.rbs +55 -0
- data/stdlib/nkf/0/nkf.rbs +35 -5
- data/stdlib/objspace/0/objspace.rbs +40 -18
- data/stdlib/observable/0/observable.rbs +217 -0
- data/stdlib/open-uri/0/manifest.yaml +4 -0
- data/stdlib/open-uri/0/open-uri.rbs +393 -0
- data/stdlib/open3/0/open3.rbs +147 -0
- data/stdlib/openssl/0/manifest.yaml +1 -0
- data/stdlib/openssl/0/openssl.rbs +681 -316
- data/stdlib/optparse/0/optparse.rbs +100 -65
- data/stdlib/pathname/0/pathname.rbs +24 -15
- data/stdlib/pp/0/manifest.yaml +2 -0
- data/stdlib/pp/0/pp.rbs +300 -0
- data/stdlib/prettyprint/0/prettyprint.rbs +2 -6
- data/stdlib/pstore/0/pstore.rbs +370 -156
- data/stdlib/psych/0/core_ext.rbs +12 -0
- data/stdlib/{yaml → psych}/0/dbm.rbs +3 -3
- data/stdlib/psych/0/manifest.yaml +3 -0
- data/stdlib/psych/0/psych.rbs +402 -0
- data/stdlib/{yaml → psych}/0/store.rbs +2 -2
- data/stdlib/pty/0/pty.rbs +63 -11
- data/stdlib/rdoc/0/code_object.rbs +51 -0
- data/stdlib/rdoc/0/comment.rbs +59 -0
- data/stdlib/rdoc/0/context.rbs +153 -0
- data/stdlib/rdoc/0/markup.rbs +117 -0
- data/stdlib/rdoc/0/parser.rbs +56 -0
- data/stdlib/rdoc/0/rdoc.rbs +13 -380
- data/stdlib/rdoc/0/ri.rbs +17 -0
- data/stdlib/rdoc/0/store.rbs +48 -0
- data/stdlib/rdoc/0/top_level.rbs +97 -0
- data/stdlib/resolv/0/resolv.rbs +16 -79
- data/stdlib/ripper/0/ripper.rbs +1648 -0
- data/stdlib/securerandom/0/securerandom.rbs +7 -2
- data/stdlib/shellwords/0/shellwords.rbs +11 -12
- data/stdlib/singleton/0/singleton.rbs +0 -3
- data/stdlib/socket/0/addrinfo.rbs +13 -18
- data/stdlib/socket/0/basic_socket.rbs +5 -10
- data/stdlib/socket/0/ip_socket.rbs +0 -2
- data/stdlib/socket/0/socket.rbs +77 -46
- data/stdlib/socket/0/tcp_server.rbs +0 -5
- data/stdlib/socket/0/tcp_socket.rbs +36 -3
- data/stdlib/socket/0/udp_socket.rbs +4 -5
- data/stdlib/socket/0/unix_server.rbs +0 -5
- data/stdlib/socket/0/unix_socket.rbs +2 -4
- data/{core/string_io.rbs → stdlib/stringio/0/stringio.rbs} +188 -107
- data/stdlib/strscan/0/string_scanner.rbs +1269 -425
- data/stdlib/tempfile/0/tempfile.rbs +224 -61
- data/stdlib/time/0/time.rbs +48 -35
- data/stdlib/timeout/0/timeout.rbs +17 -8
- data/stdlib/tmpdir/0/tmpdir.rbs +10 -3
- data/stdlib/tsort/0/tsort.rbs +0 -4
- data/stdlib/uri/0/common.rbs +271 -144
- data/stdlib/uri/0/file.rbs +5 -0
- data/stdlib/uri/0/ftp.rbs +1 -1
- data/stdlib/uri/0/generic.rbs +26 -22
- data/stdlib/uri/0/http.rbs +4 -4
- data/stdlib/uri/0/ldap.rbs +1 -1
- data/stdlib/uri/0/mailto.rbs +84 -0
- data/stdlib/uri/0/rfc2396_parser.rbs +3 -0
- data/stdlib/yaml/0/manifest.yaml +1 -2
- data/stdlib/yaml/0/yaml.rbs +1 -199
- data/stdlib/zlib/0/buf_error.rbs +10 -0
- data/stdlib/zlib/0/data_error.rbs +10 -0
- data/stdlib/zlib/0/deflate.rbs +210 -0
- data/stdlib/zlib/0/error.rbs +20 -0
- data/stdlib/zlib/0/gzip_file/crc_error.rbs +12 -0
- data/stdlib/zlib/0/gzip_file/error.rbs +23 -0
- data/stdlib/zlib/0/gzip_file/length_error.rbs +12 -0
- data/stdlib/zlib/0/gzip_file/no_footer.rbs +11 -0
- data/stdlib/zlib/0/gzip_file.rbs +156 -0
- data/stdlib/zlib/0/gzip_reader.rbs +293 -0
- data/stdlib/zlib/0/gzip_writer.rbs +166 -0
- data/stdlib/zlib/0/inflate.rbs +180 -0
- data/stdlib/zlib/0/mem_error.rbs +10 -0
- data/stdlib/zlib/0/need_dict.rbs +13 -0
- data/stdlib/zlib/0/stream_end.rbs +11 -0
- data/stdlib/zlib/0/stream_error.rbs +11 -0
- data/stdlib/zlib/0/version_error.rbs +11 -0
- data/stdlib/zlib/0/zlib.rbs +1 -3
- data/stdlib/zlib/0/zstream.rbs +200 -0
- data/templates/include/rbs/constants.h.erb +20 -0
- data/templates/include/rbs/ruby_objs.h.erb +10 -0
- data/templates/src/constants.c.erb +36 -0
- data/templates/src/ruby_objs.c.erb +27 -0
- data/templates/template.rb +122 -0
- metadata +136 -36
- data/Gemfile +0 -33
- data/Gemfile.lock +0 -118
- data/core/deprecated.rbs +0 -9
- data/ext/rbs_extension/constants.c +0 -135
- data/ext/rbs_extension/ruby_objs.c +0 -525
- data/ext/rbs_extension/ruby_objs.h +0 -43
- data/lib/rbs/constant_table.rb +0 -167
- data/lib/rbs/parser_compat/lexer_error.rb +0 -6
- data/lib/rbs/parser_compat/located_value.rb +0 -7
- data/lib/rbs/parser_compat/semantics_error.rb +0 -6
- data/lib/rbs/parser_compat/syntax_error.rb +0 -6
- data/lib/rbs/test/spy.rb +0 -6
- data/lib/rbs/type_name_resolver.rb +0 -67
- data/sig/constant_table.rbs +0 -30
- data/sig/shims/abstract_syntax_tree.rbs +0 -25
- data/sig/shims/pp.rbs +0 -3
- data/sig/shims/ripper.rbs +0 -8
- data/sig/shims.rbs +0 -69
- data/sig/type_name_resolver.rbs +0 -26
- data/stdlib/minitest/0/manifest.yaml +0 -2
- data/stdlib/prime/0/integer-extension.rbs +0 -41
- data/stdlib/prime/0/manifest.yaml +0 -2
- data/stdlib/prime/0/prime.rbs +0 -372
data/core/numeric.rbs
CHANGED
@@ -74,168 +74,88 @@
|
|
74
74
|
#
|
75
75
|
# First, what's elsewhere. Class Numeric:
|
76
76
|
#
|
77
|
-
# * Inherits from [class
|
78
|
-
#
|
79
|
-
# * Includes [module
|
80
|
-
# Comparable](Comparable.html#module-Comparable-label-What-27s+Here).
|
81
|
-
#
|
77
|
+
# * Inherits from [class Object](rdoc-ref:Object@What-27s+Here).
|
78
|
+
# * Includes [module Comparable](rdoc-ref:Comparable@What-27s+Here).
|
82
79
|
#
|
83
80
|
# Here, class Numeric provides methods for:
|
84
81
|
#
|
85
|
-
# * [Querying](
|
86
|
-
# * [Comparing](
|
87
|
-
# * [Converting](
|
88
|
-
# * [Other](
|
89
|
-
#
|
82
|
+
# * [Querying](rdoc-ref:Numeric@Querying)
|
83
|
+
# * [Comparing](rdoc-ref:Numeric@Comparing)
|
84
|
+
# * [Converting](rdoc-ref:Numeric@Converting)
|
85
|
+
# * [Other](rdoc-ref:Numeric@Other)
|
90
86
|
#
|
91
87
|
# ### Querying
|
92
88
|
#
|
93
|
-
#
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
#
|
103
|
-
# #negative?
|
104
|
-
# : Returns whether `self` is negative.
|
105
|
-
#
|
106
|
-
# #nonzero?
|
107
|
-
# : Returns whether `self` is not zero.
|
108
|
-
#
|
109
|
-
# #positive?
|
110
|
-
# : Returns whether `self` is positive.
|
111
|
-
#
|
112
|
-
# #real?
|
113
|
-
# : Returns whether `self` is a real value.
|
114
|
-
#
|
115
|
-
# #zero?
|
116
|
-
# : Returns whether `self` is zero.
|
117
|
-
#
|
118
|
-
#
|
89
|
+
# * #finite?: Returns true unless `self` is infinite or not a number.
|
90
|
+
# * #infinite?: Returns -1, `nil` or +1, depending on whether `self` is
|
91
|
+
# `-Infinity<tt>, finite, or <tt>+Infinity`.
|
92
|
+
# * #integer?: Returns whether `self` is an integer.
|
93
|
+
# * #negative?: Returns whether `self` is negative.
|
94
|
+
# * #nonzero?: Returns whether `self` is not zero.
|
95
|
+
# * #positive?: Returns whether `self` is positive.
|
96
|
+
# * #real?: Returns whether `self` is a real value.
|
97
|
+
# * #zero?: Returns whether `self` is zero.
|
119
98
|
#
|
120
99
|
# ### Comparing
|
121
100
|
#
|
122
|
-
#
|
123
|
-
# : Returns:
|
101
|
+
# * #<=>: Returns:
|
124
102
|
#
|
125
103
|
# * -1 if `self` is less than the given value.
|
126
104
|
# * 0 if `self` is equal to the given value.
|
127
105
|
# * 1 if `self` is greater than the given value.
|
128
106
|
# * `nil` if `self` and the given value are not comparable.
|
129
107
|
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
# type.
|
133
|
-
#
|
134
|
-
#
|
108
|
+
# * #eql?: Returns whether `self` and the given value have the same value and
|
109
|
+
# type.
|
135
110
|
#
|
136
111
|
# ### Converting
|
137
112
|
#
|
138
|
-
#
|
139
|
-
#
|
140
|
-
#
|
141
|
-
#
|
142
|
-
# :
|
143
|
-
#
|
144
|
-
#
|
145
|
-
# :
|
146
|
-
#
|
147
|
-
#
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
#
|
154
|
-
# :
|
155
|
-
#
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
# :
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
172
|
-
#
|
173
|
-
# :
|
174
|
-
# given divisor.
|
175
|
-
#
|
176
|
-
# #fdiv
|
177
|
-
# : Returns the Float result of dividing `self` by the given divisor.
|
178
|
-
#
|
179
|
-
# #floor
|
180
|
-
# : Returns the largest number less than or equal to `self`, to a given
|
181
|
-
# precision.
|
182
|
-
#
|
183
|
-
# #i
|
184
|
-
# : Returns the Complex object `Complex(0, self)`. the given value.
|
185
|
-
#
|
186
|
-
# #imaginary (aliased as #imag)
|
187
|
-
# : Returns the imaginary part of the `self`.
|
188
|
-
#
|
189
|
-
# #numerator
|
190
|
-
# : Returns the numerator of the Rational representation of `self`; has
|
191
|
-
# the same sign as `self`.
|
192
|
-
#
|
193
|
-
# #polar
|
194
|
-
# : Returns the array `[self.abs, self.arg]`.
|
195
|
-
#
|
196
|
-
# #quo
|
197
|
-
# : Returns the value of `self` divided by the given value.
|
198
|
-
#
|
199
|
-
# #real
|
200
|
-
# : Returns the real part of `self`.
|
201
|
-
#
|
202
|
-
# #rect (aliased as #rectangular)
|
203
|
-
# : Returns the array `[self, 0]`.
|
204
|
-
#
|
205
|
-
# #remainder
|
206
|
-
# : Returns `self-arg*(self/arg).truncate` for the given `arg`.
|
207
|
-
#
|
208
|
-
# #round
|
209
|
-
# : Returns the value of `self` rounded to the nearest value for the given
|
210
|
-
# a precision.
|
211
|
-
#
|
212
|
-
# #to_c
|
213
|
-
# : Returns the Complex representation of `self`.
|
214
|
-
#
|
215
|
-
# #to_int
|
216
|
-
# : Returns the Integer representation of `self`, truncating if necessary.
|
217
|
-
#
|
218
|
-
# #truncate
|
219
|
-
# : Returns `self` truncated (toward zero) to a given precision.
|
220
|
-
#
|
221
|
-
#
|
113
|
+
# * #% (aliased as #modulo): Returns the remainder of `self` divided by the
|
114
|
+
# given value.
|
115
|
+
# * #-@: Returns the value of `self`, negated.
|
116
|
+
# * #abs (aliased as #magnitude): Returns the absolute value of `self`.
|
117
|
+
# * #abs2: Returns the square of `self`.
|
118
|
+
# * #angle (aliased as #arg and #phase): Returns 0 if `self` is positive,
|
119
|
+
# Math::PI otherwise.
|
120
|
+
# * #ceil: Returns the smallest number greater than or equal to `self`, to a
|
121
|
+
# given precision.
|
122
|
+
# * #coerce: Returns array `[coerced_self, coerced_other]` for the given other
|
123
|
+
# value.
|
124
|
+
# * #conj (aliased as #conjugate): Returns the complex conjugate of `self`.
|
125
|
+
# * #denominator: Returns the denominator (always positive) of the Rational
|
126
|
+
# representation of `self`.
|
127
|
+
# * #div: Returns the value of `self` divided by the given value and converted
|
128
|
+
# to an integer.
|
129
|
+
# * #divmod: Returns array `[quotient, modulus]` resulting from dividing
|
130
|
+
# `self` the given divisor.
|
131
|
+
# * #fdiv: Returns the Float result of dividing `self` by the given divisor.
|
132
|
+
# * #floor: Returns the largest number less than or equal to `self`, to a
|
133
|
+
# given precision.
|
134
|
+
# * #i: Returns the Complex object `Complex(0, self)`. the given value.
|
135
|
+
# * #imaginary (aliased as #imag): Returns the imaginary part of the `self`.
|
136
|
+
# * #numerator: Returns the numerator of the Rational representation of
|
137
|
+
# `self`; has the same sign as `self`.
|
138
|
+
# * #polar: Returns the array `[self.abs, self.arg]`.
|
139
|
+
# * #quo: Returns the value of `self` divided by the given value.
|
140
|
+
# * #real: Returns the real part of `self`.
|
141
|
+
# * #rect (aliased as #rectangular): Returns the array `[self, 0]`.
|
142
|
+
# * #remainder: Returns `self-arg*(self/arg).truncate` for the given `arg`.
|
143
|
+
# * #round: Returns the value of `self` rounded to the nearest value for the
|
144
|
+
# given a precision.
|
145
|
+
# * #to_c: Returns the Complex representation of `self`.
|
146
|
+
# * #to_int: Returns the Integer representation of `self`, truncating if
|
147
|
+
# necessary.
|
148
|
+
# * #truncate: Returns `self` truncated (toward zero) to a given precision.
|
222
149
|
#
|
223
150
|
# ### Other
|
224
151
|
#
|
225
|
-
#
|
226
|
-
# :
|
227
|
-
#
|
228
|
-
# #dup (aliased as #+@)
|
229
|
-
# : Returns `self`.
|
230
|
-
#
|
231
|
-
# #step
|
232
|
-
# : Invokes the given block with the sequence of specified numbers.
|
152
|
+
# * #clone: Returns `self`; does not allow freezing.
|
153
|
+
# * #dup (aliased as #+@): Returns `self`.
|
154
|
+
# * #step: Invokes the given block with the sequence of specified numbers.
|
233
155
|
#
|
234
156
|
class Numeric
|
235
157
|
include Comparable
|
236
158
|
|
237
|
-
public
|
238
|
-
|
239
159
|
# <!--
|
240
160
|
# rdoc-file=numeric.c
|
241
161
|
# - self % other -> real_numeric
|
@@ -247,9 +167,9 @@ class Numeric
|
|
247
167
|
#
|
248
168
|
# For Rational `r` and real number `n`, these expressions are equivalent:
|
249
169
|
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
170
|
+
# r % n
|
171
|
+
# r-n*(r/n).floor
|
172
|
+
# r.divmod(n)[1]
|
253
173
|
#
|
254
174
|
# See Numeric#divmod.
|
255
175
|
#
|
@@ -268,8 +188,6 @@ class Numeric
|
|
268
188
|
# (-r) % r2 # => (119/100)
|
269
189
|
# (-r) %-r2 # => (-21/100)
|
270
190
|
#
|
271
|
-
# Numeric#modulo is an alias for Numeric#%.
|
272
|
-
#
|
273
191
|
def %: (Numeric) -> Numeric
|
274
192
|
|
275
193
|
# Performs addition: the class of the resulting object depends on the class of
|
@@ -278,7 +196,7 @@ class Numeric
|
|
278
196
|
def +: (Numeric) -> Numeric
|
279
197
|
|
280
198
|
# <!--
|
281
|
-
# rdoc-file=numeric.
|
199
|
+
# rdoc-file=numeric.rb
|
282
200
|
# - +self -> self
|
283
201
|
# -->
|
284
202
|
# Returns `self`.
|
@@ -318,42 +236,40 @@ class Numeric
|
|
318
236
|
# (-34.56).abs #=> 34.56
|
319
237
|
# -34.56.abs #=> 34.56
|
320
238
|
#
|
321
|
-
# Numeric#magnitude is an alias for Numeric#abs.
|
322
|
-
#
|
323
239
|
def abs: () -> Numeric
|
324
240
|
|
325
241
|
# <!--
|
326
242
|
# rdoc-file=complex.c
|
327
|
-
# -
|
243
|
+
# - abs2 -> real
|
328
244
|
# -->
|
329
|
-
# Returns square of self
|
245
|
+
# Returns the square of `self`.
|
330
246
|
#
|
331
247
|
def abs2: () -> Numeric
|
332
248
|
|
333
249
|
# <!-- rdoc-file=complex.c -->
|
334
|
-
# Returns
|
250
|
+
# Returns zero if `self` is positive, Math::PI otherwise.
|
335
251
|
#
|
336
252
|
def angle: () -> Numeric
|
337
253
|
|
338
254
|
# <!--
|
339
255
|
# rdoc-file=complex.c
|
340
|
-
# -
|
341
|
-
# - num.angle -> 0 or float
|
342
|
-
# - num.phase -> 0 or float
|
256
|
+
# - arg -> 0 or Math::PI
|
343
257
|
# -->
|
344
|
-
# Returns
|
258
|
+
# Returns zero if `self` is positive, Math::PI otherwise.
|
345
259
|
#
|
346
260
|
alias arg angle
|
347
261
|
|
348
262
|
# <!--
|
349
263
|
# rdoc-file=numeric.c
|
350
|
-
# - ceil(
|
264
|
+
# - ceil(ndigits = 0) -> float or integer
|
351
265
|
# -->
|
352
|
-
# Returns the smallest
|
353
|
-
#
|
266
|
+
# Returns the smallest float or integer that is greater than or equal to `self`,
|
267
|
+
# as specified by the given `ndigits`, which must be an [integer-convertible
|
268
|
+
# object](rdoc-ref:implicit_conversion.rdoc@Integer-Convertible+Objects).
|
354
269
|
#
|
355
|
-
#
|
356
|
-
#
|
270
|
+
# Equivalent to `self.to_f.ceil(ndigits)`.
|
271
|
+
#
|
272
|
+
# Related: #floor, Float#ceil.
|
357
273
|
#
|
358
274
|
def ceil: () -> Integer
|
359
275
|
| (Integer digits) -> (Integer | Numeric)
|
@@ -392,17 +308,18 @@ class Numeric
|
|
392
308
|
#
|
393
309
|
def coerce: (Numeric) -> [ Numeric, Numeric ]
|
394
310
|
|
395
|
-
# <!--
|
396
|
-
#
|
311
|
+
# <!--
|
312
|
+
# rdoc-file=numeric.rb
|
313
|
+
# - conj()
|
314
|
+
# -->
|
397
315
|
#
|
398
316
|
def conj: () -> Numeric
|
399
317
|
|
400
318
|
# <!--
|
401
|
-
# rdoc-file=
|
402
|
-
# -
|
403
|
-
# - num.conjugate -> self
|
319
|
+
# rdoc-file=numeric.rb
|
320
|
+
# - conj -> self
|
404
321
|
# -->
|
405
|
-
# Returns self
|
322
|
+
# Returns `self`.
|
406
323
|
#
|
407
324
|
def conjugate: () -> Numeric
|
408
325
|
|
@@ -422,8 +339,8 @@ class Numeric
|
|
422
339
|
# `/` in the derived class of `self`. (Numeric itself does not define method
|
423
340
|
# `/`.)
|
424
341
|
#
|
425
|
-
# Of the Core and Standard Library classes, Float
|
426
|
-
#
|
342
|
+
# Of the Core and Standard Library classes, Only Float and Rational use this
|
343
|
+
# implementation.
|
427
344
|
#
|
428
345
|
def div: (Numeric) -> Integer
|
429
346
|
|
@@ -472,8 +389,8 @@ class Numeric
|
|
472
389
|
# 1.eql?(Rational(1, 1)) # => false
|
473
390
|
# 1.eql?(Complex(1, 0)) # => false
|
474
391
|
#
|
475
|
-
# Method `eql?` is different from
|
476
|
-
# while
|
392
|
+
# Method `eql?` is different from `==` in that `eql?` requires matching types,
|
393
|
+
# while `==` does not.
|
477
394
|
#
|
478
395
|
def eql?: (untyped) -> bool
|
479
396
|
|
@@ -491,21 +408,23 @@ class Numeric
|
|
491
408
|
|
492
409
|
# <!--
|
493
410
|
# rdoc-file=numeric.rb
|
494
|
-
# -
|
411
|
+
# - finite? -> true or false
|
495
412
|
# -->
|
496
|
-
# Returns `true` if `
|
413
|
+
# Returns `true` if `self` is a finite number, `false` otherwise.
|
497
414
|
#
|
498
415
|
def finite?: () -> bool
|
499
416
|
|
500
417
|
# <!--
|
501
418
|
# rdoc-file=numeric.c
|
502
|
-
# - floor(
|
419
|
+
# - floor(ndigits = 0) -> float or integer
|
503
420
|
# -->
|
504
|
-
# Returns the largest
|
505
|
-
#
|
421
|
+
# Returns the largest float or integer that is less than or equal to `self`, as
|
422
|
+
# specified by the given `ndigits`, which must be an [integer-convertible
|
423
|
+
# object](rdoc-ref:implicit_conversion.rdoc@Integer-Convertible+Objects).
|
506
424
|
#
|
507
|
-
#
|
508
|
-
#
|
425
|
+
# Equivalent to `self.to_f.floor(ndigits)`.
|
426
|
+
#
|
427
|
+
# Related: #ceil, Float#floor.
|
509
428
|
#
|
510
429
|
def floor: () -> Integer
|
511
430
|
| (Integer digits) -> Numeric
|
@@ -524,15 +443,16 @@ class Numeric
|
|
524
443
|
#
|
525
444
|
def i: () -> Complex
|
526
445
|
|
527
|
-
# <!--
|
528
|
-
#
|
446
|
+
# <!--
|
447
|
+
# rdoc-file=numeric.rb
|
448
|
+
# - imag()
|
449
|
+
# -->
|
529
450
|
#
|
530
451
|
def imag: () -> Numeric
|
531
452
|
|
532
453
|
# <!--
|
533
|
-
# rdoc-file=
|
534
|
-
# -
|
535
|
-
# - num.imaginary -> 0
|
454
|
+
# rdoc-file=numeric.rb
|
455
|
+
# - imag -> 0
|
536
456
|
# -->
|
537
457
|
# Returns zero.
|
538
458
|
#
|
@@ -540,21 +460,21 @@ class Numeric
|
|
540
460
|
|
541
461
|
# <!--
|
542
462
|
# rdoc-file=numeric.rb
|
543
|
-
# -
|
463
|
+
# - infinite? -> -1, 1, or nil
|
544
464
|
# -->
|
545
|
-
# Returns `nil`, -1, or 1 depending on whether
|
546
|
-
#
|
465
|
+
# Returns `nil`, -1, or 1 depending on whether `self` is finite, `-Infinity`, or
|
466
|
+
# `+Infinity`.
|
547
467
|
#
|
548
468
|
def infinite?: () -> Integer?
|
549
469
|
|
550
470
|
# <!--
|
551
471
|
# rdoc-file=numeric.rb
|
552
|
-
# -
|
472
|
+
# - integer? -> true or false
|
553
473
|
# -->
|
554
|
-
# Returns `true` if `
|
474
|
+
# Returns `true` if `self` is an Integer.
|
555
475
|
#
|
556
|
-
# 1.0.integer?
|
557
|
-
# 1.integer?
|
476
|
+
# 1.0.integer? # => false
|
477
|
+
# 1.integer? # => true
|
558
478
|
#
|
559
479
|
def integer?: () -> bool
|
560
480
|
|
@@ -565,8 +485,6 @@ class Numeric
|
|
565
485
|
# (-34.56).abs #=> 34.56
|
566
486
|
# -34.56.abs #=> 34.56
|
567
487
|
#
|
568
|
-
# Numeric#magnitude is an alias for Numeric#abs.
|
569
|
-
#
|
570
488
|
alias magnitude abs
|
571
489
|
|
572
490
|
# <!-- rdoc-file=numeric.c -->
|
@@ -577,9 +495,9 @@ class Numeric
|
|
577
495
|
#
|
578
496
|
# For Rational `r` and real number `n`, these expressions are equivalent:
|
579
497
|
#
|
580
|
-
#
|
581
|
-
#
|
582
|
-
#
|
498
|
+
# r % n
|
499
|
+
# r-n*(r/n).floor
|
500
|
+
# r.divmod(n)[1]
|
583
501
|
#
|
584
502
|
# See Numeric#divmod.
|
585
503
|
#
|
@@ -598,8 +516,6 @@ class Numeric
|
|
598
516
|
# (-r) % r2 # => (119/100)
|
599
517
|
# (-r) %-r2 # => (-21/100)
|
600
518
|
#
|
601
|
-
# Numeric#modulo is an alias for Numeric#%.
|
602
|
-
#
|
603
519
|
def modulo: (Numeric) -> Numeric
|
604
520
|
|
605
521
|
# <!--
|
@@ -614,17 +530,19 @@ class Numeric
|
|
614
530
|
# rdoc-file=numeric.c
|
615
531
|
# - nonzero? -> self or nil
|
616
532
|
# -->
|
617
|
-
# Returns
|
618
|
-
#
|
533
|
+
# Returns +self+ if +self+ is not a zero value, +nil+ otherwise;
|
534
|
+
# uses method <tt>zero?</tt> for the evaluation.
|
535
|
+
#
|
536
|
+
# The returned +self+ allows the method to be chained:
|
619
537
|
#
|
620
|
-
#
|
538
|
+
# a = %w[z Bb bB bb BB a aA Aa AA A]
|
539
|
+
# a.sort {|a, b| (a.downcase <=> b.downcase).nonzero? || a <=> b }
|
540
|
+
# # => ["A", "a", "AA", "Aa", "aA", "BB", "Bb", "bB", "bb", "z"]
|
621
541
|
#
|
622
|
-
#
|
623
|
-
#
|
624
|
-
# # => ["A", "a", "AA", "Aa", "aA", "BB", "Bb", "bB", "bb", "z"]
|
542
|
+
# Of the Core and Standard Library classes,
|
543
|
+
# Integer, Float, Rational, and Complex use this implementation.
|
625
544
|
#
|
626
|
-
#
|
627
|
-
# Complex use this implementation.
|
545
|
+
# Related: #zero?
|
628
546
|
#
|
629
547
|
def nonzero?: () -> self?
|
630
548
|
|
@@ -637,15 +555,15 @@ class Numeric
|
|
637
555
|
def numerator: () -> Numeric
|
638
556
|
|
639
557
|
# <!-- rdoc-file=complex.c -->
|
640
|
-
# Returns
|
558
|
+
# Returns zero if `self` is positive, Math::PI otherwise.
|
641
559
|
#
|
642
560
|
alias phase angle
|
643
561
|
|
644
562
|
# <!--
|
645
563
|
# rdoc-file=complex.c
|
646
|
-
# -
|
564
|
+
# - polar -> array
|
647
565
|
# -->
|
648
|
-
# Returns
|
566
|
+
# Returns array `[self.abs, self.arg]`.
|
649
567
|
#
|
650
568
|
def polar: () -> [ Numeric, Numeric ]
|
651
569
|
|
@@ -667,32 +585,31 @@ class Numeric
|
|
667
585
|
def quo: (Numeric) -> Numeric
|
668
586
|
|
669
587
|
# <!--
|
670
|
-
# rdoc-file=
|
671
|
-
# -
|
588
|
+
# rdoc-file=numeric.rb
|
589
|
+
# - real -> self
|
672
590
|
# -->
|
673
|
-
# Returns self
|
591
|
+
# Returns `self`.
|
674
592
|
#
|
675
593
|
def real: () -> Numeric
|
676
594
|
|
677
595
|
# <!--
|
678
596
|
# rdoc-file=numeric.rb
|
679
|
-
# -
|
597
|
+
# - real? -> true or false
|
680
598
|
# -->
|
681
|
-
# Returns `true` if `
|
599
|
+
# Returns `true` if `self` is a real number (i.e. not Complex).
|
682
600
|
#
|
683
601
|
def real?: () -> bool
|
684
602
|
|
685
603
|
# <!-- rdoc-file=complex.c -->
|
686
|
-
# Returns
|
604
|
+
# Returns array `[self, 0]`.
|
687
605
|
#
|
688
606
|
def rect: () -> [ Numeric, Numeric ]
|
689
607
|
|
690
608
|
# <!--
|
691
609
|
# rdoc-file=complex.c
|
692
|
-
# -
|
693
|
-
# - num.rectangular -> array
|
610
|
+
# - rect -> array
|
694
611
|
# -->
|
695
|
-
# Returns
|
612
|
+
# Returns array `[self, 0]`.
|
696
613
|
#
|
697
614
|
alias rectangular rect
|
698
615
|
|
@@ -753,86 +670,83 @@ class Numeric
|
|
753
670
|
# -->
|
754
671
|
# Generates a sequence of numbers; with a block given, traverses the sequence.
|
755
672
|
#
|
756
|
-
#
|
757
|
-
#
|
758
|
-
#
|
759
|
-
#
|
760
|
-
#
|
761
|
-
#
|
762
|
-
#
|
763
|
-
#
|
764
|
-
#
|
765
|
-
#
|
766
|
-
#
|
767
|
-
#
|
768
|
-
#
|
769
|
-
#
|
770
|
-
#
|
771
|
-
#
|
772
|
-
#
|
773
|
-
#
|
774
|
-
#
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
778
|
-
#
|
779
|
-
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
785
|
-
#
|
786
|
-
#
|
787
|
-
#
|
788
|
-
#
|
789
|
-
#
|
790
|
-
#
|
791
|
-
#
|
792
|
-
#
|
793
|
-
#
|
794
|
-
#
|
795
|
-
#
|
796
|
-
#
|
797
|
-
#
|
798
|
-
#
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
802
|
-
#
|
803
|
-
#
|
804
|
-
#
|
805
|
-
#
|
806
|
-
#
|
807
|
-
#
|
808
|
-
#
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
#
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
816
|
-
#
|
817
|
-
#
|
818
|
-
#
|
819
|
-
#
|
820
|
-
#
|
821
|
-
#
|
822
|
-
#
|
823
|
-
#
|
824
|
-
#
|
825
|
-
# squares # => [16, 25, 36, 49, 64, 81, 100, 121]
|
673
|
+
# Of the Core and Standard Library classes, Integer, Float, and Rational use
|
674
|
+
# this implementation.
|
675
|
+
#
|
676
|
+
# A quick example:
|
677
|
+
#
|
678
|
+
# squares = []
|
679
|
+
# 1.step(by: 2, to: 10) {|i| squares.push(i*i) }
|
680
|
+
# squares # => [1, 9, 25, 49, 81]
|
681
|
+
#
|
682
|
+
# The generated sequence:
|
683
|
+
#
|
684
|
+
# * Begins with `self`.
|
685
|
+
# * Continues at intervals of `by` (which may not be zero).
|
686
|
+
# * Ends with the last number that is within or equal to `to`; that is, less
|
687
|
+
# than or equal to `to` if `by` is positive, greater than or equal to `to`
|
688
|
+
# if `by` is negative. If `to` is `nil`, the sequence is of infinite length.
|
689
|
+
#
|
690
|
+
# If a block is given, calls the block with each number in the sequence; returns
|
691
|
+
# `self`. If no block is given, returns an Enumerator::ArithmeticSequence.
|
692
|
+
#
|
693
|
+
# **Keyword Arguments**
|
694
|
+
#
|
695
|
+
# With keyword arguments `by` and `to`, their values (or defaults) determine the
|
696
|
+
# step and limit:
|
697
|
+
#
|
698
|
+
# # Both keywords given.
|
699
|
+
# squares = []
|
700
|
+
# 4.step(by: 2, to: 10) {|i| squares.push(i*i) } # => 4
|
701
|
+
# squares # => [16, 36, 64, 100]
|
702
|
+
# cubes = []
|
703
|
+
# 3.step(by: -1.5, to: -3) {|i| cubes.push(i*i*i) } # => 3
|
704
|
+
# cubes # => [27.0, 3.375, 0.0, -3.375, -27.0]
|
705
|
+
# squares = []
|
706
|
+
# 1.2.step(by: 0.2, to: 2.0) {|f| squares.push(f*f) }
|
707
|
+
# squares # => [1.44, 1.9599999999999997, 2.5600000000000005, 3.24, 4.0]
|
708
|
+
#
|
709
|
+
# squares = []
|
710
|
+
# Rational(6/5).step(by: 0.2, to: 2.0) {|r| squares.push(r*r) }
|
711
|
+
# squares # => [1.0, 1.44, 1.9599999999999997, 2.5600000000000005, 3.24, 4.0]
|
712
|
+
#
|
713
|
+
# # Only keyword to given.
|
714
|
+
# squares = []
|
715
|
+
# 4.step(to: 10) {|i| squares.push(i*i) } # => 4
|
716
|
+
# squares # => [16, 25, 36, 49, 64, 81, 100]
|
717
|
+
# # Only by given.
|
718
|
+
#
|
719
|
+
# # Only keyword by given
|
720
|
+
# squares = []
|
721
|
+
# 4.step(by:2) {|i| squares.push(i*i); break if i > 10 }
|
722
|
+
# squares # => [16, 36, 64, 100, 144]
|
723
|
+
#
|
724
|
+
# # No block given.
|
725
|
+
# e = 3.step(by: -1.5, to: -3) # => (3.step(by: -1.5, to: -3))
|
726
|
+
# e.class # => Enumerator::ArithmeticSequence
|
727
|
+
#
|
728
|
+
# **Positional Arguments**
|
729
|
+
#
|
730
|
+
# With optional positional arguments `to` and `by`, their values (or defaults)
|
731
|
+
# determine the step and limit:
|
732
|
+
#
|
733
|
+
# squares = []
|
734
|
+
# 4.step(10, 2) {|i| squares.push(i*i) } # => 4
|
735
|
+
# squares # => [16, 36, 64, 100]
|
736
|
+
# squares = []
|
737
|
+
# 4.step(10) {|i| squares.push(i*i) }
|
738
|
+
# squares # => [16, 25, 36, 49, 64, 81, 100]
|
739
|
+
# squares = []
|
740
|
+
# 4.step {|i| squares.push(i*i); break if i > 10 } # => nil
|
741
|
+
# squares # => [16, 25, 36, 49, 64, 81, 100, 121]
|
826
742
|
#
|
827
743
|
# **Implementation Notes**
|
828
744
|
#
|
829
|
-
#
|
830
|
-
# counter.
|
745
|
+
# If all the arguments are integers, the loop operates using an integer counter.
|
831
746
|
#
|
832
|
-
#
|
833
|
-
#
|
834
|
-
#
|
835
|
-
# where <i>n = (limit - self)/step</i>.
|
747
|
+
# If any of the arguments are floating point numbers, all are converted to
|
748
|
+
# floats, and the loop is executed *floor(n + n*Float::EPSILON) + 1* times,
|
749
|
+
# where *n = (limit - self)/step*.
|
836
750
|
#
|
837
751
|
def step: (?Numeric limit, ?Numeric step) { (Numeric) -> void } -> self
|
838
752
|
| (?Numeric limit, ?Numeric step) -> Enumerator[Numeric, self]
|
@@ -841,9 +755,9 @@ class Numeric
|
|
841
755
|
|
842
756
|
# <!--
|
843
757
|
# rdoc-file=complex.c
|
844
|
-
# -
|
758
|
+
# - to_c -> complex
|
845
759
|
# -->
|
846
|
-
# Returns
|
760
|
+
# Returns `self` as a Complex object.
|
847
761
|
#
|
848
762
|
def to_c: () -> Complex
|
849
763
|
|
@@ -862,7 +776,7 @@ class Numeric
|
|
862
776
|
# Rational(1, 2).to_int # => 0
|
863
777
|
# Rational(2, 1).to_int # => 2
|
864
778
|
# Complex(2, 0).to_int # => 2
|
865
|
-
# Complex(2, 1)
|
779
|
+
# Complex(2, 1).to_int # Raises RangeError (non-zero imaginary part)
|
866
780
|
#
|
867
781
|
def to_int: () -> Integer
|
868
782
|
|