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/integer.rbs
CHANGED
@@ -3,14 +3,11 @@
|
|
3
3
|
#
|
4
4
|
# You can create an Integer object explicitly with:
|
5
5
|
#
|
6
|
-
# * An [integer
|
7
|
-
# literal](doc/syntax/literals_rdoc.html#label-Integer+Literals).
|
8
|
-
#
|
6
|
+
# * An [integer literal](rdoc-ref:syntax/literals.rdoc@Integer+Literals).
|
9
7
|
#
|
10
8
|
# You can convert certain objects to Integers with:
|
11
9
|
#
|
12
|
-
# * Method
|
13
|
-
#
|
10
|
+
# * Method #Integer.
|
14
11
|
#
|
15
12
|
# An attempt to add a singleton method to an instance of this class causes an
|
16
13
|
# exception to be raised.
|
@@ -19,161 +16,81 @@
|
|
19
16
|
#
|
20
17
|
# First, what's elsewhere. Class Integer:
|
21
18
|
#
|
22
|
-
# * Inherits from [class
|
23
|
-
#
|
24
|
-
#
|
19
|
+
# * Inherits from [class Numeric](rdoc-ref:Numeric@What-27s+Here) and [class
|
20
|
+
# Object](rdoc-ref:Object@What-27s+Here).
|
21
|
+
# * Includes [module Comparable](rdoc-ref:Comparable@What-27s+Here).
|
25
22
|
#
|
26
23
|
# Here, class Integer provides methods for:
|
27
24
|
#
|
28
|
-
# * [Querying](
|
29
|
-
# * [Comparing](
|
30
|
-
# * [Converting](
|
31
|
-
# * [Other](
|
32
|
-
#
|
25
|
+
# * [Querying](rdoc-ref:Integer@Querying)
|
26
|
+
# * [Comparing](rdoc-ref:Integer@Comparing)
|
27
|
+
# * [Converting](rdoc-ref:Integer@Converting)
|
28
|
+
# * [Other](rdoc-ref:Integer@Other)
|
33
29
|
#
|
34
30
|
# ### Querying
|
35
31
|
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
# #anybits?
|
40
|
-
# : Returns whether any bits in `self` are set.
|
41
|
-
#
|
42
|
-
# #nobits?
|
43
|
-
# : Returns whether no bits in `self` are set.
|
44
|
-
#
|
45
|
-
#
|
32
|
+
# * #allbits?: Returns whether all bits in `self` are set.
|
33
|
+
# * #anybits?: Returns whether any bits in `self` are set.
|
34
|
+
# * #nobits?: Returns whether no bits in `self` are set.
|
46
35
|
#
|
47
36
|
# ### Comparing
|
48
37
|
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
# :
|
54
|
-
#
|
55
|
-
# [<=>](#method-i-3C-3D-3E)
|
56
|
-
# : Returns a number indicating whether `self` is less than, equal to, or
|
57
|
-
# greater than the given value.
|
58
|
-
#
|
59
|
-
# [==](#method-i-3D-3D) (aliased as #===)
|
60
|
-
# : Returns whether `self` is equal to the given value.
|
61
|
-
#
|
62
|
-
# [>](#method-i-3E)
|
63
|
-
# : Returns whether `self` is greater than the given value.
|
64
|
-
#
|
65
|
-
# [>=](#method-i-3E-3D)
|
66
|
-
# : Returns whether `self` is greater than or equal to the given value.
|
67
|
-
#
|
38
|
+
# * #<: Returns whether `self` is less than the given value.
|
39
|
+
# * #<=: Returns whether `self` is less than or equal to the given value.
|
40
|
+
# * #<=>: Returns a number indicating whether `self` is less than, equal to,
|
41
|
+
# or greater than the given value.
|
42
|
+
# * #== (aliased as #===): Returns whether `self` is equal to the given
|
43
|
+
# value.
|
68
44
|
#
|
45
|
+
# * #>: Returns whether `self` is greater than the given value.
|
46
|
+
# * #>=: Returns whether `self` is greater than or equal to the given value.
|
69
47
|
#
|
70
48
|
# ### Converting
|
71
49
|
#
|
72
|
-
#
|
73
|
-
# :
|
74
|
-
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
# :
|
92
|
-
#
|
93
|
-
#
|
94
|
-
# :
|
95
|
-
#
|
96
|
-
#
|
97
|
-
# :
|
98
|
-
#
|
99
|
-
#
|
100
|
-
# :
|
101
|
-
#
|
102
|
-
#
|
103
|
-
# :
|
104
|
-
#
|
105
|
-
#
|
106
|
-
# :
|
107
|
-
#
|
108
|
-
# [^](#method-i-5E)
|
109
|
-
# : Returns the bitwise EXCLUSIVE OR of `self` and the given value.
|
110
|
-
#
|
111
|
-
# #ceil
|
112
|
-
# : Returns the smallest number greater than or equal to `self`.
|
113
|
-
#
|
114
|
-
# #chr
|
115
|
-
# : Returns a 1-character string containing the character represented by
|
116
|
-
# the value of `self`.
|
117
|
-
#
|
118
|
-
# #digits
|
119
|
-
# : Returns an array of integers representing the base-radix digits of
|
120
|
-
# `self`.
|
121
|
-
#
|
122
|
-
# #div
|
123
|
-
# : Returns the integer result of dividing `self` by the given value.
|
124
|
-
#
|
125
|
-
# #divmod
|
126
|
-
# : Returns a 2-element array containing the quotient and remainder
|
127
|
-
# results of dividing `self` by the given value.
|
128
|
-
#
|
129
|
-
# #fdiv
|
130
|
-
# : Returns the Float result of dividing `self` by the given value.
|
131
|
-
#
|
132
|
-
# #floor
|
133
|
-
# : Returns the greatest number smaller than or equal to `self`.
|
134
|
-
#
|
135
|
-
# #pow
|
136
|
-
# : Returns the modular exponentiation of `self`.
|
137
|
-
#
|
138
|
-
# #pred
|
139
|
-
# : Returns the integer predecessor of `self`.
|
140
|
-
#
|
141
|
-
# #remainder
|
142
|
-
# : Returns the remainder after dividing `self` by the given value.
|
143
|
-
#
|
144
|
-
# #round
|
145
|
-
# : Returns `self` rounded to the nearest value with the given precision.
|
146
|
-
#
|
147
|
-
# #succ (aliased as #next)
|
148
|
-
# : Returns the integer successor of `self`.
|
149
|
-
#
|
150
|
-
# #to_f
|
151
|
-
# : Returns `self` converted to a Float.
|
152
|
-
#
|
153
|
-
# #to_s (aliased as #inspect)
|
154
|
-
# : Returns a string containing the place-value representation of `self`
|
155
|
-
# in the given radix.
|
156
|
-
#
|
157
|
-
# #truncate
|
158
|
-
# : Returns `self` truncated to the given precision.
|
159
|
-
#
|
160
|
-
# [/](#method-i-7C)
|
161
|
-
# : Returns the bitwise OR of `self` and the given value.
|
162
|
-
#
|
163
|
-
#
|
50
|
+
# * ::sqrt: Returns the integer square root of the given value.
|
51
|
+
# * ::try_convert: Returns the given value converted to an Integer.
|
52
|
+
# * #% (aliased as #modulo): Returns `self` modulo the given value.
|
53
|
+
# * #&: Returns the bitwise AND of `self` and the given value.
|
54
|
+
# * #*: Returns the product of `self` and the given value.
|
55
|
+
# * #**: Returns the value of `self` raised to the power of the given value.
|
56
|
+
# * #+: Returns the sum of `self` and the given value.
|
57
|
+
# * #-: Returns the difference of `self` and the given value.
|
58
|
+
# * #/: Returns the quotient of `self` and the given value.
|
59
|
+
# * #<<: Returns the value of `self` after a leftward bit-shift.
|
60
|
+
# * #>>: Returns the value of `self` after a rightward bit-shift.
|
61
|
+
# * #[]: Returns a slice of bits from `self`.
|
62
|
+
# * #^: Returns the bitwise EXCLUSIVE OR of `self` and the given value.
|
63
|
+
# * #|: Returns the bitwise OR of `self` and the given value.
|
64
|
+
# * #ceil: Returns the smallest number greater than or equal to `self`.
|
65
|
+
# * #chr: Returns a 1-character string containing the character represented by
|
66
|
+
# the value of `self`.
|
67
|
+
# * #digits: Returns an array of integers representing the base-radix digits
|
68
|
+
# of `self`.
|
69
|
+
# * #div: Returns the integer result of dividing `self` by the given value.
|
70
|
+
# * #divmod: Returns a 2-element array containing the quotient and remainder
|
71
|
+
# results of dividing `self` by the given value.
|
72
|
+
# * #fdiv: Returns the Float result of dividing `self` by the given value.
|
73
|
+
# * #floor: Returns the greatest number smaller than or equal to `self`.
|
74
|
+
# * #pow: Returns the modular exponentiation of `self`.
|
75
|
+
# * #pred: Returns the integer predecessor of `self`.
|
76
|
+
# * #remainder: Returns the remainder after dividing `self` by the given
|
77
|
+
# value.
|
78
|
+
# * #round: Returns `self` rounded to the nearest value with the given
|
79
|
+
# precision.
|
80
|
+
# * #succ (aliased as #next): Returns the integer successor of `self`.
|
81
|
+
# * #to_f: Returns `self` converted to a Float.
|
82
|
+
# * #to_s (aliased as #inspect): Returns a string containing the place-value
|
83
|
+
# representation of `self` in the given radix.
|
84
|
+
# * #truncate: Returns `self` truncated to the given precision.
|
164
85
|
#
|
165
86
|
# ### Other
|
166
87
|
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
172
|
-
#
|
173
|
-
#
|
174
|
-
# #upto
|
175
|
-
# : Calls the given block with each integer value from `self` up to the
|
176
|
-
# given value.
|
88
|
+
# * #downto: Calls the given block with each integer value from `self` down to
|
89
|
+
# the given value.
|
90
|
+
# * #times: Calls the given block `self` times with each integer in
|
91
|
+
# `(0..self-1)`.
|
92
|
+
# * #upto: Calls the given block with each integer value from `self` up to the
|
93
|
+
# given value.
|
177
94
|
#
|
178
95
|
class Integer < Numeric
|
179
96
|
# <!--
|
@@ -209,7 +126,7 @@ class Integer < Numeric
|
|
209
126
|
def self.sqrt: (int n) -> Integer
|
210
127
|
|
211
128
|
# <!--
|
212
|
-
# rdoc-file=numeric.
|
129
|
+
# rdoc-file=numeric.c
|
213
130
|
# - Integer.try_convert(object) -> object, integer, or nil
|
214
131
|
# -->
|
215
132
|
# If `object` is an Integer object, returns `object`.
|
@@ -227,8 +144,6 @@ class Integer < Numeric
|
|
227
144
|
def self.try_convert: (int) -> Integer
|
228
145
|
| (untyped) -> Integer?
|
229
146
|
|
230
|
-
public
|
231
|
-
|
232
147
|
# <!--
|
233
148
|
# rdoc-file=numeric.c
|
234
149
|
# - self % other -> real_number
|
@@ -256,8 +171,6 @@ class Integer < Numeric
|
|
256
171
|
# 10 % 3.0 # => 1.0
|
257
172
|
# 10 % Rational(3, 1) # => (1/1)
|
258
173
|
#
|
259
|
-
# Integer#modulo is an alias for Integer#%.
|
260
|
-
#
|
261
174
|
def %: (Float) -> Float
|
262
175
|
| (Rational) -> Rational
|
263
176
|
| (Integer) -> Integer
|
@@ -355,9 +268,9 @@ class Integer < Numeric
|
|
355
268
|
|
356
269
|
# <!--
|
357
270
|
# rdoc-file=numeric.rb
|
358
|
-
# - -int
|
271
|
+
# - -int -> integer
|
359
272
|
# -->
|
360
|
-
# Returns `
|
273
|
+
# Returns `self`, negated.
|
361
274
|
#
|
362
275
|
def -@: () -> Integer
|
363
276
|
|
@@ -444,7 +357,6 @@ class Integer < Numeric
|
|
444
357
|
# * 1, if `self` is greater then `other`.
|
445
358
|
# * `nil`, if `self` and `other` are incomparable.
|
446
359
|
#
|
447
|
-
#
|
448
360
|
# Examples:
|
449
361
|
#
|
450
362
|
# 1 <=> 2 # => -1
|
@@ -469,8 +381,6 @@ class Integer < Numeric
|
|
469
381
|
#
|
470
382
|
# Related: Integer#eql? (requires `other` to be an Integer).
|
471
383
|
#
|
472
|
-
# Integer#=== is an alias for Integer#==.
|
473
|
-
#
|
474
384
|
def ==: (untyped) -> bool
|
475
385
|
|
476
386
|
# <!--
|
@@ -484,8 +394,6 @@ class Integer < Numeric
|
|
484
394
|
#
|
485
395
|
# Related: Integer#eql? (requires `other` to be an Integer).
|
486
396
|
#
|
487
|
-
# Integer#=== is an alias for Integer#==.
|
488
|
-
#
|
489
397
|
def ===: (untyped) -> bool
|
490
398
|
|
491
399
|
# <!--
|
@@ -597,16 +505,13 @@ class Integer < Numeric
|
|
597
505
|
|
598
506
|
# <!--
|
599
507
|
# rdoc-file=numeric.rb
|
600
|
-
# -
|
601
|
-
# - int.magnitude -> integer
|
508
|
+
# - abs -> integer
|
602
509
|
# -->
|
603
|
-
# Returns the absolute value of `
|
510
|
+
# Returns the absolute value of `self`.
|
604
511
|
#
|
605
|
-
# (-12345).abs
|
606
|
-
# -12345.abs
|
607
|
-
# 12345.abs
|
608
|
-
#
|
609
|
-
# Integer#magnitude is an alias for Integer#abs.
|
512
|
+
# (-12345).abs # => 12345
|
513
|
+
# -12345.abs # => 12345
|
514
|
+
# 12345.abs # => 12345
|
610
515
|
#
|
611
516
|
def abs: () -> Integer
|
612
517
|
|
@@ -664,44 +569,43 @@ class Integer < Numeric
|
|
664
569
|
|
665
570
|
# <!--
|
666
571
|
# rdoc-file=numeric.rb
|
667
|
-
# -
|
572
|
+
# - bit_length -> integer
|
668
573
|
# -->
|
669
|
-
# Returns the number of bits of the value of `
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
# (-2**1000
|
678
|
-
# (-2**1000).bit_length
|
679
|
-
# (-2**
|
680
|
-
# (-2**12
|
681
|
-
# (-2**12).bit_length
|
682
|
-
#
|
683
|
-
# -
|
684
|
-
# -
|
685
|
-
# -
|
686
|
-
# -
|
687
|
-
#
|
688
|
-
#
|
689
|
-
#
|
690
|
-
#
|
691
|
-
#
|
692
|
-
# (2**12
|
693
|
-
# (2**12).bit_length
|
694
|
-
# (2**
|
695
|
-
# (2**1000
|
696
|
-
# (2**1000).bit_length
|
697
|
-
#
|
698
|
-
#
|
699
|
-
# This method can be used to detect overflow in Array#pack as follows:
|
574
|
+
# Returns the number of bits of the value of `self`, which is the bit position
|
575
|
+
# of the highest-order bit that is different from the sign bit (where the least
|
576
|
+
# significant bit has bit position 1). If there is no such bit (zero or minus
|
577
|
+
# one), returns zero.
|
578
|
+
#
|
579
|
+
# This method returns `ceil(log2(self < 0 ? -self : self + 1))`>.
|
580
|
+
#
|
581
|
+
# (-2**1000-1).bit_length # => 1001
|
582
|
+
# (-2**1000).bit_length # => 1000
|
583
|
+
# (-2**1000+1).bit_length # => 1000
|
584
|
+
# (-2**12-1).bit_length # => 13
|
585
|
+
# (-2**12).bit_length # => 12
|
586
|
+
# (-2**12+1).bit_length # => 12
|
587
|
+
# -0x101.bit_length # => 9
|
588
|
+
# -0x100.bit_length # => 8
|
589
|
+
# -0xff.bit_length # => 8
|
590
|
+
# -2.bit_length # => 1
|
591
|
+
# -1.bit_length # => 0
|
592
|
+
# 0.bit_length # => 0
|
593
|
+
# 1.bit_length # => 1
|
594
|
+
# 0xff.bit_length # => 8
|
595
|
+
# 0x100.bit_length # => 9
|
596
|
+
# (2**12-1).bit_length # => 12
|
597
|
+
# (2**12).bit_length # => 13
|
598
|
+
# (2**12+1).bit_length # => 13
|
599
|
+
# (2**1000-1).bit_length # => 1000
|
600
|
+
# (2**1000).bit_length # => 1001
|
601
|
+
# (2**1000+1).bit_length # => 1001
|
602
|
+
#
|
603
|
+
# For Integer *n*, this method can be used to detect overflow in Array#pack:
|
700
604
|
#
|
701
605
|
# if n.bit_length < 32
|
702
|
-
# [n].pack(
|
606
|
+
# [n].pack('l') # No overflow.
|
703
607
|
# else
|
704
|
-
# raise
|
608
|
+
# raise 'Overflow'
|
705
609
|
# end
|
706
610
|
#
|
707
611
|
def bit_length: () -> Integer
|
@@ -710,26 +614,62 @@ class Integer < Numeric
|
|
710
614
|
# rdoc-file=numeric.c
|
711
615
|
# - ceil(ndigits = 0) -> integer
|
712
616
|
# -->
|
713
|
-
# Returns
|
714
|
-
#
|
715
|
-
#
|
716
|
-
#
|
717
|
-
#
|
617
|
+
# Returns an integer that is a "ceiling" value for `self`,
|
618
|
+
# as specified by the given `ndigits`,
|
619
|
+
# which must be an
|
620
|
+
# [integer-convertible
|
621
|
+
# object](rdoc-ref:implicit_conversion.rdoc@Integer-Convertible+Objects).
|
622
|
+
# * When `self` is zero, returns zero (regardless of the value of `ndigits`):
|
623
|
+
# 0.ceil(2) # => 0
|
624
|
+
# 0.ceil(-2) # => 0
|
625
|
+
#
|
626
|
+
# * When `self` is non-zero and `ndigits` is non-negative, returns `self`:
|
627
|
+
# 555.ceil # => 555
|
628
|
+
# 555.ceil(50) # => 555
|
629
|
+
#
|
630
|
+
# * When `self` is non-zero and `ndigits` is negative,
|
631
|
+
# returns a value based on a computed granularity:
|
632
|
+
# * The granularity is `10 ** ndigits.abs`.
|
633
|
+
# * The returned value is the smallest multiple of the granularity
|
634
|
+
# that is greater than or equal to `self`.
|
635
|
+
# Examples with positive `self`:
|
636
|
+
# ndigits|Granularity|1234.ceil(ndigits)
|
637
|
+
# -------|-----------|------------------
|
638
|
+
# -1| 10| 1240
|
639
|
+
# -2| 100| 1300
|
640
|
+
# -3| 1000| 2000
|
641
|
+
# -4| 10000| 10000
|
642
|
+
# -5| 100000| 100000
|
643
|
+
# Examples with negative `self`:
|
644
|
+
# ndigits|Granularity|-1234.ceil(ndigits)
|
645
|
+
# -------|-----------|-------------------
|
646
|
+
# -1| 10| -1230
|
647
|
+
# -2| 100| -1200
|
648
|
+
# -3| 1000| -1000
|
649
|
+
# -4| 10000| 0
|
650
|
+
# -5| 100000| 0
|
651
|
+
# Related: Integer#floor.
|
718
652
|
#
|
719
|
-
|
720
|
-
|
721
|
-
|
722
|
-
#
|
653
|
+
def ceil: () -> Integer
|
654
|
+
| (int digits) -> (Integer | Float)
|
655
|
+
|
656
|
+
# <!--
|
657
|
+
# rdoc-file=numeric.rb
|
658
|
+
# - ceildiv(numeric) -> integer
|
659
|
+
# -->
|
660
|
+
# Returns the result of division `self` by `numeric`. rounded up to the nearest
|
661
|
+
# integer.
|
723
662
|
#
|
724
|
-
#
|
663
|
+
# 3.ceildiv(3) # => 1
|
664
|
+
# 4.ceildiv(3) # => 2
|
725
665
|
#
|
726
|
-
#
|
727
|
-
#
|
666
|
+
# 4.ceildiv(-3) # => -1
|
667
|
+
# -4.ceildiv(3) # => -1
|
668
|
+
# -4.ceildiv(-3) # => 2
|
728
669
|
#
|
729
|
-
#
|
670
|
+
# 3.ceildiv(1.2) # => 3
|
730
671
|
#
|
731
|
-
def
|
732
|
-
| (int digits) -> (Integer | Float)
|
672
|
+
def ceildiv: (Numeric other) -> Integer
|
733
673
|
|
734
674
|
# <!--
|
735
675
|
# rdoc-file=numeric.c
|
@@ -740,7 +680,7 @@ class Integer < Numeric
|
|
740
680
|
# of `self`, according to the given `encoding`.
|
741
681
|
#
|
742
682
|
# 65.chr # => "A"
|
743
|
-
# 0
|
683
|
+
# 0.chr # => "\x00"
|
744
684
|
# 255.chr # => "\xFF"
|
745
685
|
# string = 255.chr(Encoding::UTF_8)
|
746
686
|
# string.encoding # => Encoding::UTF_8
|
@@ -753,14 +693,14 @@ class Integer < Numeric
|
|
753
693
|
|
754
694
|
# <!--
|
755
695
|
# rdoc-file=bignum.c
|
756
|
-
# -
|
696
|
+
# - int.coerce(numeric) -> array
|
757
697
|
# -->
|
758
|
-
# Returns an array with both a `numeric` and a `
|
759
|
-
# objects.
|
698
|
+
# Returns an array with both a `numeric` and a `int` represented as Integer
|
699
|
+
# objects or Float objects.
|
760
700
|
#
|
761
|
-
# This is achieved by converting `numeric` to a
|
701
|
+
# This is achieved by converting `numeric` to an Integer or a Float.
|
762
702
|
#
|
763
|
-
# A TypeError is raised if the `numeric` is not
|
703
|
+
# A TypeError is raised if the `numeric` is not an Integer or a Float type.
|
764
704
|
#
|
765
705
|
# (0x3FFFFFFFFFFFFFFF+1).coerce(42) #=> [42, 4611686018427387904]
|
766
706
|
#
|
@@ -771,10 +711,10 @@ class Integer < Numeric
|
|
771
711
|
def conjugate: () -> Integer
|
772
712
|
|
773
713
|
# <!--
|
774
|
-
# rdoc-file=
|
775
|
-
# -
|
714
|
+
# rdoc-file=numeric.rb
|
715
|
+
# - denominator -> 1
|
776
716
|
# -->
|
777
|
-
# Returns 1
|
717
|
+
# Returns `1`.
|
778
718
|
#
|
779
719
|
def denominator: () -> Integer
|
780
720
|
|
@@ -800,14 +740,14 @@ class Integer < Numeric
|
|
800
740
|
# Performs integer division; returns the integer result of dividing `self` by
|
801
741
|
# `numeric`:
|
802
742
|
#
|
803
|
-
#
|
804
|
-
#
|
805
|
-
#
|
806
|
-
#
|
807
|
-
#
|
808
|
-
#
|
743
|
+
# 4.div(3) # => 1
|
744
|
+
# 4.div(-3) # => -2
|
745
|
+
# -4.div(3) # => -2
|
746
|
+
# -4.div(-3) # => 1
|
747
|
+
# 4.div(3.0) # => 1
|
748
|
+
# 4.div(Rational(3, 1)) # => 1
|
809
749
|
#
|
810
|
-
#
|
750
|
+
# Raises an exception if `numeric` does not have method `div`.
|
811
751
|
#
|
812
752
|
def div: (Numeric) -> Integer
|
813
753
|
|
@@ -836,7 +776,8 @@ class Integer < Numeric
|
|
836
776
|
# 13.divmod(Rational(4, 1)) # => [3, (1/1)]
|
837
777
|
#
|
838
778
|
def divmod: (Integer) -> [ Integer, Integer ]
|
839
|
-
| (Float) -> [
|
779
|
+
| (Float) -> [ Integer, Float ]
|
780
|
+
| (Rational) -> [ Integer, Rational ]
|
840
781
|
| (Numeric) -> [ Numeric, Numeric ]
|
841
782
|
|
842
783
|
# <!--
|
@@ -866,9 +807,9 @@ class Integer < Numeric
|
|
866
807
|
|
867
808
|
# <!--
|
868
809
|
# rdoc-file=numeric.rb
|
869
|
-
# -
|
810
|
+
# - even? -> true or false
|
870
811
|
# -->
|
871
|
-
# Returns `true` if `
|
812
|
+
# Returns `true` if `self` is an even number, `false` otherwise.
|
872
813
|
#
|
873
814
|
def even?: () -> bool
|
874
815
|
|
@@ -894,22 +835,40 @@ class Integer < Numeric
|
|
894
835
|
# rdoc-file=numeric.c
|
895
836
|
# - floor(ndigits = 0) -> integer
|
896
837
|
# -->
|
897
|
-
# Returns
|
898
|
-
# `ndigits
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
#
|
903
|
-
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
838
|
+
# Returns an integer that is a "floor" value for `self`,
|
839
|
+
# as specified by the given `ndigits`,
|
840
|
+
# which must be an
|
841
|
+
# [integer-convertible
|
842
|
+
# object](rdoc-ref:implicit_conversion.rdoc@Integer-Convertible+Objects).
|
843
|
+
# * When `self` is zero, returns zero (regardless of the value of `ndigits`):
|
844
|
+
# 0.floor(2) # => 0
|
845
|
+
# 0.floor(-2) # => 0
|
846
|
+
#
|
847
|
+
# * When `self` is non-zero and `ndigits` is non-negative, returns `self`:
|
848
|
+
# 555.floor # => 555
|
849
|
+
# 555.floor(50) # => 555
|
850
|
+
#
|
851
|
+
# * When `self` is non-zero and `ndigits` is negative,
|
852
|
+
# returns a value based on a computed granularity:
|
853
|
+
# * The granularity is `10 ** ndigits.abs`.
|
854
|
+
# * The returned value is the largest multiple of the granularity
|
855
|
+
# that is less than or equal to `self`.
|
856
|
+
# Examples with positive `self`:
|
857
|
+
# ndigits|Granularity|1234.floor(ndigits)
|
858
|
+
# -------|-----------|-------------------
|
859
|
+
# -1| 10| 1230
|
860
|
+
# -2| 100| 1200
|
861
|
+
# -3| 1000| 1000
|
862
|
+
# -4| 10000| 0
|
863
|
+
# -5| 100000| 0
|
864
|
+
# Examples with negative `self`:
|
865
|
+
# ndigits|Granularity|-1234.floor(ndigits)
|
866
|
+
# -------|-----------|--------------------
|
867
|
+
# -1| 10| -1240
|
868
|
+
# -2| 100| -1300
|
869
|
+
# -3| 1000| -2000
|
870
|
+
# -4| 10000| -10000
|
871
|
+
# -5| 100000| -100000
|
913
872
|
# Related: Integer#ceil.
|
914
873
|
#
|
915
874
|
def floor: (?int digits) -> Integer
|
@@ -964,15 +923,13 @@ class Integer < Numeric
|
|
964
923
|
#
|
965
924
|
# Raises an exception if `base` is out of range.
|
966
925
|
#
|
967
|
-
# Integer#inspect is an alias for Integer#to_s.
|
968
|
-
#
|
969
926
|
alias inspect to_s
|
970
927
|
|
971
928
|
# <!--
|
972
929
|
# rdoc-file=numeric.rb
|
973
|
-
# -
|
930
|
+
# - integer? -> true
|
974
931
|
# -->
|
975
|
-
# Since `
|
932
|
+
# Since `self` is already an Integer, always returns `true`.
|
976
933
|
#
|
977
934
|
def integer?: () -> true
|
978
935
|
|
@@ -1021,8 +978,6 @@ class Integer < Numeric
|
|
1021
978
|
# 10 % 3.0 # => 1.0
|
1022
979
|
# 10 % Rational(3, 1) # => (1/1)
|
1023
980
|
#
|
1024
|
-
# Integer#modulo is an alias for Integer#%.
|
1025
|
-
#
|
1026
981
|
alias modulo %
|
1027
982
|
|
1028
983
|
def negative?: () -> bool
|
@@ -1033,8 +988,6 @@ class Integer < Numeric
|
|
1033
988
|
# 1.succ #=> 2
|
1034
989
|
# -1.succ #=> 0
|
1035
990
|
#
|
1036
|
-
# Integer#next is an alias for Integer#succ.
|
1037
|
-
#
|
1038
991
|
# Related: Integer#pred (predecessor value).
|
1039
992
|
#
|
1040
993
|
def next: () -> Integer
|
@@ -1065,32 +1018,26 @@ class Integer < Numeric
|
|
1065
1018
|
def nonzero?: () -> self?
|
1066
1019
|
|
1067
1020
|
# <!--
|
1068
|
-
# rdoc-file=
|
1069
|
-
# -
|
1021
|
+
# rdoc-file=numeric.rb
|
1022
|
+
# - numerator -> self
|
1070
1023
|
# -->
|
1071
|
-
# Returns self
|
1024
|
+
# Returns `self`.
|
1072
1025
|
#
|
1073
1026
|
def numerator: () -> Integer
|
1074
1027
|
|
1075
1028
|
# <!--
|
1076
1029
|
# rdoc-file=numeric.rb
|
1077
|
-
# -
|
1030
|
+
# - odd? -> true or false
|
1078
1031
|
# -->
|
1079
|
-
# Returns `true` if `
|
1032
|
+
# Returns `true` if `self` is an odd number, `false` otherwise.
|
1080
1033
|
#
|
1081
1034
|
def odd?: () -> bool
|
1082
1035
|
|
1083
1036
|
# <!--
|
1084
1037
|
# rdoc-file=numeric.rb
|
1085
|
-
# -
|
1038
|
+
# - ord -> self
|
1086
1039
|
# -->
|
1087
|
-
# Returns
|
1088
|
-
#
|
1089
|
-
# 97.ord #=> 97
|
1090
|
-
#
|
1091
|
-
# This method is intended for compatibility to character literals in Ruby 1.9.
|
1092
|
-
#
|
1093
|
-
# For example, `?a.ord` returns 97 both in 1.8 and 1.9.
|
1040
|
+
# Returns `self`; intended for compatibility to character literals in Ruby 1.9.
|
1094
1041
|
#
|
1095
1042
|
def ord: () -> Integer
|
1096
1043
|
|
@@ -1110,9 +1057,10 @@ class Integer < Numeric
|
|
1110
1057
|
# a.pow(b) #=> same as a**b
|
1111
1058
|
# a.pow(b, m) #=> same as (a**b) % m, but avoids huge temporary values
|
1112
1059
|
#
|
1113
|
-
def pow: (Integer other
|
1114
|
-
| (
|
1115
|
-
| (
|
1060
|
+
def pow: (Integer other) -> (Integer | Rational)
|
1061
|
+
| (Integer other, Integer modulo) -> Integer
|
1062
|
+
| (Float) -> (Float | Complex)
|
1063
|
+
| (Rational) -> (Float | Rational | Complex)
|
1116
1064
|
| (Complex) -> Complex
|
1117
1065
|
|
1118
1066
|
# <!--
|
@@ -1218,7 +1166,6 @@ class Integer < Numeric
|
|
1218
1166
|
# 15.round(-1, half: :even) # => 20
|
1219
1167
|
# (-25).round(-1, half: :even) # => -20
|
1220
1168
|
#
|
1221
|
-
#
|
1222
1169
|
# Raises and exception if the value for `half` is invalid.
|
1223
1170
|
#
|
1224
1171
|
# Related: Integer#truncate.
|
@@ -1228,19 +1175,17 @@ class Integer < Numeric
|
|
1228
1175
|
|
1229
1176
|
# <!--
|
1230
1177
|
# rdoc-file=numeric.rb
|
1231
|
-
# -
|
1178
|
+
# - size -> integer
|
1232
1179
|
# -->
|
1233
|
-
#
|
1234
|
-
#
|
1235
|
-
# Returns the number of bytes in the machine representation of `int` (machine
|
1236
|
-
# dependent).
|
1180
|
+
# Returns the number of bytes in the machine representation of `self`; the value
|
1181
|
+
# is system-dependent:
|
1237
1182
|
#
|
1238
|
-
# 1.size
|
1239
|
-
# -1.size
|
1240
|
-
# 2147483647.size
|
1241
|
-
# (256**10 - 1).size
|
1242
|
-
# (256**20 - 1).size
|
1243
|
-
# (256**40 - 1).size
|
1183
|
+
# 1.size # => 8
|
1184
|
+
# -1.size # => 8
|
1185
|
+
# 2147483647.size # => 8
|
1186
|
+
# (256**10 - 1).size # => 10
|
1187
|
+
# (256**20 - 1).size # => 20
|
1188
|
+
# (256**40 - 1).size # => 40
|
1244
1189
|
#
|
1245
1190
|
def size: () -> Integer
|
1246
1191
|
|
@@ -1250,10 +1195,10 @@ class Integer < Numeric
|
|
1250
1195
|
| (to: Numeric, ?by: Integer) { (Integer) -> void } -> void
|
1251
1196
|
| (by: Numeric, ?to: Numeric) { (Numeric) -> void } -> void
|
1252
1197
|
| () -> Enumerator[Integer, bot]
|
1253
|
-
| (Numeric limit, ?Integer step) -> Enumerator[Integer
|
1254
|
-
| (Numeric limit, ?Numeric step) -> Enumerator[Numeric
|
1255
|
-
| (to: Numeric, ?by: Integer) -> Enumerator[Integer
|
1256
|
-
| (by: Numeric, ?to: Numeric) -> Enumerator[Numeric
|
1198
|
+
| (Numeric limit, ?Integer step) -> Enumerator[Integer]
|
1199
|
+
| (Numeric limit, ?Numeric step) -> Enumerator[Numeric]
|
1200
|
+
| (to: Numeric, ?by: Integer) -> Enumerator[Integer]
|
1201
|
+
| (by: Numeric, ?to: Numeric) -> Enumerator[Numeric]
|
1257
1202
|
|
1258
1203
|
# <!--
|
1259
1204
|
# rdoc-file=numeric.c
|
@@ -1264,14 +1209,12 @@ class Integer < Numeric
|
|
1264
1209
|
# 1.succ #=> 2
|
1265
1210
|
# -1.succ #=> 0
|
1266
1211
|
#
|
1267
|
-
# Integer#next is an alias for Integer#succ.
|
1268
|
-
#
|
1269
1212
|
# Related: Integer#pred (predecessor value).
|
1270
1213
|
#
|
1271
1214
|
def succ: () -> Integer
|
1272
1215
|
|
1273
1216
|
# <!--
|
1274
|
-
# rdoc-file=numeric.
|
1217
|
+
# rdoc-file=numeric.rb
|
1275
1218
|
# - times {|i| ... } -> self
|
1276
1219
|
# - times -> enumerator
|
1277
1220
|
# -->
|
@@ -1306,19 +1249,17 @@ class Integer < Numeric
|
|
1306
1249
|
|
1307
1250
|
# <!--
|
1308
1251
|
# rdoc-file=numeric.rb
|
1309
|
-
# -
|
1252
|
+
# - to_i -> self
|
1310
1253
|
# -->
|
1311
|
-
#
|
1312
|
-
#
|
1313
|
-
# #to_int is an alias for #to_i.
|
1254
|
+
# Returns `self` (which is already an Integer).
|
1314
1255
|
#
|
1315
1256
|
def to_i: () -> Integer
|
1316
1257
|
|
1317
1258
|
# <!--
|
1318
1259
|
# rdoc-file=numeric.rb
|
1319
|
-
# -
|
1260
|
+
# - to_int -> self
|
1320
1261
|
# -->
|
1321
|
-
#
|
1262
|
+
# Returns `self` (which is already an Integer).
|
1322
1263
|
#
|
1323
1264
|
alias to_int to_i
|
1324
1265
|
|
@@ -1350,8 +1291,6 @@ class Integer < Numeric
|
|
1350
1291
|
#
|
1351
1292
|
# Raises an exception if `base` is out of range.
|
1352
1293
|
#
|
1353
|
-
# Integer#inspect is an alias for Integer#to_s.
|
1354
|
-
#
|
1355
1294
|
def to_s: () -> String
|
1356
1295
|
| (2) -> String
|
1357
1296
|
| (3) -> String
|
@@ -1437,9 +1376,9 @@ class Integer < Numeric
|
|
1437
1376
|
|
1438
1377
|
# <!--
|
1439
1378
|
# rdoc-file=numeric.rb
|
1440
|
-
# -
|
1379
|
+
# - zero? -> true or false
|
1441
1380
|
# -->
|
1442
|
-
# Returns `true` if `
|
1381
|
+
# Returns `true` if `self` has a zero value, `false` otherwise.
|
1443
1382
|
#
|
1444
1383
|
def zero?: () -> bool
|
1445
1384
|
|
@@ -1460,16 +1399,15 @@ class Integer < Numeric
|
|
1460
1399
|
|
1461
1400
|
# <!--
|
1462
1401
|
# rdoc-file=numeric.rb
|
1463
|
-
# - ~int
|
1402
|
+
# - ~int -> integer
|
1464
1403
|
# -->
|
1465
|
-
# One's complement: returns
|
1404
|
+
# One's complement: returns the value of `self` with each bit inverted.
|
1466
1405
|
#
|
1467
|
-
#
|
1468
|
-
#
|
1469
|
-
#
|
1470
|
-
# the digits.
|
1406
|
+
# Because an integer value is conceptually of infinite length, the result acts
|
1407
|
+
# as if it had an infinite number of one bits to the left. In hex
|
1408
|
+
# representations, this is displayed as two periods to the left of the digits:
|
1471
1409
|
#
|
1472
|
-
# sprintf("%X", ~0x1122334455)
|
1410
|
+
# sprintf("%X", ~0x1122334455) # => "..FEEDDCCBBAA"
|
1473
1411
|
#
|
1474
1412
|
def ~: () -> Integer
|
1475
1413
|
end
|