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/math.rbs
CHANGED
@@ -1,489 +1,729 @@
|
|
1
1
|
# <!-- rdoc-file=math.c -->
|
2
|
-
#
|
3
|
-
# transcendental functions
|
4
|
-
# Ruby's floating point accuracy.
|
2
|
+
# Module Math provides methods for basic trigonometric, logarithmic, and
|
3
|
+
# transcendental functions, and for extracting roots.
|
5
4
|
#
|
6
|
-
#
|
5
|
+
# You can write its constants and method calls thus:
|
6
|
+
#
|
7
|
+
# Math::PI # => 3.141592653589793
|
8
|
+
# Math::E # => 2.718281828459045
|
9
|
+
# Math.sin(0.0) # => 0.0
|
10
|
+
# Math.cos(0.0) # => 1.0
|
11
|
+
#
|
12
|
+
# If you include module Math, you can write simpler forms:
|
13
|
+
#
|
14
|
+
# include Math
|
15
|
+
# PI # => 3.141592653589793
|
16
|
+
# E # => 2.718281828459045
|
17
|
+
# sin(0.0) # => 0.0
|
18
|
+
# cos(0.0) # => 1.0
|
19
|
+
#
|
20
|
+
# For simplicity, the examples here assume:
|
21
|
+
#
|
22
|
+
# include Math
|
23
|
+
# INFINITY = Float::INFINITY
|
24
|
+
#
|
25
|
+
# The domains and ranges for the methods are denoted by open or closed
|
26
|
+
# intervals, using, respectively, parentheses or square brackets:
|
27
|
+
#
|
28
|
+
# * An open interval does not include the endpoints:
|
29
|
+
#
|
30
|
+
# (-INFINITY, INFINITY)
|
31
|
+
#
|
32
|
+
# * A closed interval includes the endpoints:
|
33
|
+
#
|
34
|
+
# [-1.0, 1.0]
|
35
|
+
#
|
36
|
+
# * A half-open interval includes one endpoint, but not the other:
|
37
|
+
#
|
38
|
+
# [1.0, INFINITY)
|
39
|
+
#
|
40
|
+
# Many values returned by Math methods are numerical approximations. This is
|
41
|
+
# because many such values are, in mathematics, of infinite precision, while in
|
42
|
+
# numerical computation the precision is finite.
|
43
|
+
#
|
44
|
+
# Thus, in mathematics, *cos(π/2)* is exactly zero, but in our computation
|
45
|
+
# `cos(PI/2)` is a number very close to zero:
|
46
|
+
#
|
47
|
+
# cos(PI/2) # => 6.123031769111886e-17
|
48
|
+
#
|
49
|
+
# For very large and very small returned values, we have added formatted numbers
|
50
|
+
# for clarity:
|
51
|
+
#
|
52
|
+
# tan(PI/2) # => 1.633123935319537e+16 # 16331239353195370.0
|
53
|
+
# tan(PI) # => -1.2246467991473532e-16 # -0.0000000000000001
|
54
|
+
#
|
55
|
+
# See class Float for the constants that affect Ruby's floating-point
|
56
|
+
# arithmetic.
|
57
|
+
#
|
58
|
+
# ### What's Here
|
59
|
+
#
|
60
|
+
# #### Trigonometric Functions
|
61
|
+
#
|
62
|
+
# * ::cos: Returns the cosine of the given argument.
|
63
|
+
# * ::sin: Returns the sine of the given argument.
|
64
|
+
# * ::tan: Returns the tangent of the given argument.
|
65
|
+
#
|
66
|
+
# #### Inverse Trigonometric Functions
|
67
|
+
#
|
68
|
+
# * ::acos: Returns the arc cosine of the given argument.
|
69
|
+
# * ::asin: Returns the arc sine of the given argument.
|
70
|
+
# * ::atan: Returns the arc tangent of the given argument.
|
71
|
+
# * ::atan2: Returns the arg tangent of two given arguments.
|
72
|
+
#
|
73
|
+
# #### Hyperbolic Trigonometric Functions
|
74
|
+
#
|
75
|
+
# * ::cosh: Returns the hyperbolic cosine of the given argument.
|
76
|
+
# * ::sinh: Returns the hyperbolic sine of the given argument.
|
77
|
+
# * ::tanh: Returns the hyperbolic tangent of the given argument.
|
78
|
+
#
|
79
|
+
# #### Inverse Hyperbolic Trigonometric Functions
|
80
|
+
#
|
81
|
+
# * ::acosh: Returns the inverse hyperbolic cosine of the given argument.
|
82
|
+
# * ::asinh: Returns the inverse hyperbolic sine of the given argument.
|
83
|
+
# * ::atanh: Returns the inverse hyperbolic tangent of the given argument.
|
84
|
+
#
|
85
|
+
# #### Exponentiation and Logarithmic Functions
|
86
|
+
#
|
87
|
+
# * ::exp: Returns the value of a given value raised to a given power.
|
88
|
+
# * ::log: Returns the logarithm of a given value in a given base.
|
89
|
+
# * ::log10: Returns the base 10 logarithm of the given argument.
|
90
|
+
# * ::log2: Returns the base 2 logarithm of the given argument.
|
91
|
+
#
|
92
|
+
# #### Fraction and Exponent Functions
|
93
|
+
#
|
94
|
+
# * ::frexp: Returns the fraction and exponent of the given argument.
|
95
|
+
# * ::ldexp: Returns the value for a given fraction and exponent.
|
96
|
+
#
|
97
|
+
# #### Root Functions
|
98
|
+
#
|
99
|
+
# * ::cbrt: Returns the cube root of the given argument.
|
100
|
+
# * ::sqrt: Returns the square root of the given argument.
|
101
|
+
#
|
102
|
+
# #### Error Functions
|
103
|
+
#
|
104
|
+
# * ::erf: Returns the value of the Gauss error function for the given
|
105
|
+
# argument.
|
106
|
+
# * ::erfc: Returns the value of the complementary error function for the
|
107
|
+
# given argument.
|
108
|
+
#
|
109
|
+
# #### Gamma Functions
|
110
|
+
#
|
111
|
+
# * ::gamma: Returns the value of the gamma function for the given argument.
|
112
|
+
# * ::lgamma: Returns the value of the logarithmic gamma function for the
|
113
|
+
# given argument.
|
114
|
+
#
|
115
|
+
# #### Hypotenuse Function
|
116
|
+
#
|
117
|
+
# * ::hypot: Returns `sqrt(a**2 + b**2)` for the given `a` and `b`.
|
7
118
|
#
|
8
119
|
module Math
|
120
|
+
# <!-- rdoc-file=math.c -->
|
121
|
+
# Definition of the mathematical constant E for Euler's number (e) as a Float
|
122
|
+
# number.
|
123
|
+
#
|
124
|
+
E: Float
|
125
|
+
|
126
|
+
# <!-- rdoc-file=math.c -->
|
127
|
+
# Definition of the mathematical constant PI as a Float number.
|
128
|
+
#
|
129
|
+
PI: Float
|
130
|
+
|
131
|
+
# <!-- rdoc-file=math.c -->
|
132
|
+
# Raised when a mathematical function is evaluated outside of its domain of
|
133
|
+
# definition.
|
134
|
+
#
|
135
|
+
# For example, since `cos` returns values in the range -1..1, its inverse
|
136
|
+
# function `acos` is only defined on that interval:
|
137
|
+
#
|
138
|
+
# Math.acos(42)
|
139
|
+
#
|
140
|
+
# *produces:*
|
141
|
+
#
|
142
|
+
# Math::DomainError: Numerical argument is out of domain - "acos"
|
143
|
+
#
|
144
|
+
class DomainError < StandardError
|
145
|
+
end
|
146
|
+
|
147
|
+
# A type that's passable to `Math` functions: A `Numeric` type that defines `.to_f`.
|
148
|
+
#
|
149
|
+
type double = Numeric & _ToF
|
150
|
+
|
9
151
|
# <!--
|
10
152
|
# rdoc-file=math.c
|
11
|
-
# - Math.acos(x)
|
153
|
+
# - Math.acos(x) -> float
|
12
154
|
# -->
|
13
|
-
#
|
155
|
+
# Returns the [arc
|
156
|
+
# cosine](https://en.wikipedia.org/wiki/Inverse_trigonometric_functions) of `x`.
|
14
157
|
#
|
15
|
-
# Domain: [-1, 1]
|
158
|
+
# * Domain: `[-1, 1]`.
|
159
|
+
# * Range: `[0, PI]`.
|
16
160
|
#
|
17
|
-
#
|
161
|
+
# Examples:
|
18
162
|
#
|
19
|
-
#
|
163
|
+
# acos(-1.0) # => 3.141592653589793 # PI
|
164
|
+
# acos(0.0) # => 1.5707963267948966 # PI/2
|
165
|
+
# acos(1.0) # => 0.0
|
20
166
|
#
|
21
|
-
def self.acos: (
|
167
|
+
def self.acos: (double x) -> Float
|
22
168
|
|
23
169
|
# <!--
|
24
170
|
# rdoc-file=math.c
|
25
|
-
# - Math.acosh(x)
|
171
|
+
# - Math.acosh(x) -> float
|
26
172
|
# -->
|
27
|
-
#
|
173
|
+
# Returns the [inverse hyperbolic
|
174
|
+
# cosine](https://en.wikipedia.org/wiki/Inverse_hyperbolic_functions) of `x`.
|
28
175
|
#
|
29
|
-
# Domain: [1, INFINITY
|
176
|
+
# * Domain: `[1, INFINITY]`.
|
177
|
+
# * Range: `[0, INFINITY]`.
|
30
178
|
#
|
31
|
-
#
|
179
|
+
# Examples:
|
32
180
|
#
|
33
|
-
#
|
181
|
+
# acosh(1.0) # => 0.0
|
182
|
+
# acosh(INFINITY) # => Infinity
|
34
183
|
#
|
35
|
-
def self.acosh: (
|
184
|
+
def self.acosh: (double x) -> Float
|
36
185
|
|
37
186
|
# <!--
|
38
187
|
# rdoc-file=math.c
|
39
|
-
# - Math.asin(x)
|
188
|
+
# - Math.asin(x) -> float
|
40
189
|
# -->
|
41
|
-
#
|
190
|
+
# Returns the [arc
|
191
|
+
# sine](https://en.wikipedia.org/wiki/Inverse_trigonometric_functions) of `x`.
|
42
192
|
#
|
43
|
-
# Domain: [-1, -1]
|
193
|
+
# * Domain: `[-1, -1]`.
|
194
|
+
# * Range: `[-PI/2, PI/2]`.
|
44
195
|
#
|
45
|
-
#
|
196
|
+
# Examples:
|
46
197
|
#
|
47
|
-
#
|
198
|
+
# asin(-1.0) # => -1.5707963267948966 # -PI/2
|
199
|
+
# asin(0.0) # => 0.0
|
200
|
+
# asin(1.0) # => 1.5707963267948966 # PI/2
|
48
201
|
#
|
49
|
-
def self.asin: (
|
202
|
+
def self.asin: (double x) -> Float
|
50
203
|
|
51
204
|
# <!--
|
52
205
|
# rdoc-file=math.c
|
53
|
-
# - Math.asinh(x)
|
206
|
+
# - Math.asinh(x) -> float
|
54
207
|
# -->
|
55
|
-
#
|
208
|
+
# Returns the [inverse hyperbolic
|
209
|
+
# sine](https://en.wikipedia.org/wiki/Inverse_hyperbolic_functions) of `x`.
|
56
210
|
#
|
57
|
-
# Domain:
|
211
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
212
|
+
# * Range: `[-INFINITY, INFINITY]`.
|
58
213
|
#
|
59
|
-
#
|
214
|
+
# Examples:
|
60
215
|
#
|
61
|
-
#
|
216
|
+
# asinh(-INFINITY) # => -Infinity
|
217
|
+
# asinh(0.0) # => 0.0
|
218
|
+
# asinh(INFINITY) # => Infinity
|
62
219
|
#
|
63
|
-
def self.asinh: (
|
220
|
+
def self.asinh: (double x) -> Float
|
64
221
|
|
65
222
|
# <!--
|
66
223
|
# rdoc-file=math.c
|
67
224
|
# - Math.atan(x) -> Float
|
68
225
|
# -->
|
69
|
-
#
|
226
|
+
# Returns the [arc
|
227
|
+
# tangent](https://en.wikipedia.org/wiki/Inverse_trigonometric_functions) of
|
228
|
+
# `x`.
|
70
229
|
#
|
71
|
-
# Domain:
|
230
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
231
|
+
# * Range: `[-PI/2, PI/2] `.
|
72
232
|
#
|
73
|
-
#
|
233
|
+
# Examples:
|
74
234
|
#
|
75
|
-
#
|
235
|
+
# atan(-INFINITY) # => -1.5707963267948966 # -PI2
|
236
|
+
# atan(-PI) # => -1.2626272556789115
|
237
|
+
# atan(-PI/2) # => -1.0038848218538872
|
238
|
+
# atan(0.0) # => 0.0
|
239
|
+
# atan(PI/2) # => 1.0038848218538872
|
240
|
+
# atan(PI) # => 1.2626272556789115
|
241
|
+
# atan(INFINITY) # => 1.5707963267948966 # PI/2
|
76
242
|
#
|
77
|
-
def self.atan: (
|
243
|
+
def self.atan: (double x) -> Float
|
78
244
|
|
79
245
|
# <!--
|
80
246
|
# rdoc-file=math.c
|
81
|
-
# - Math.atan2(y, x)
|
247
|
+
# - Math.atan2(y, x) -> float
|
82
248
|
# -->
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
#
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
97
|
-
#
|
98
|
-
#
|
99
|
-
|
100
|
-
# Math.atan2(0.0, -1.0) #=> 3.141592653589793
|
101
|
-
# Math.atan2(INFINITY, INFINITY) #=> 0.7853981633974483
|
102
|
-
# Math.atan2(INFINITY, -INFINITY) #=> 2.356194490192345
|
103
|
-
# Math.atan2(-INFINITY, INFINITY) #=> -0.7853981633974483
|
104
|
-
# Math.atan2(-INFINITY, -INFINITY) #=> -2.356194490192345
|
105
|
-
#
|
106
|
-
def self.atan2: (Numeric y, Numeric x) -> Float
|
249
|
+
# Returns the [arc tangent](https://en.wikipedia.org/wiki/Atan2) of `y` and `x`
|
250
|
+
# in
|
251
|
+
# [radians](https://en.wikipedia.org/wiki/Trigonometric_functions#Radians_versus
|
252
|
+
# _degrees).
|
253
|
+
#
|
254
|
+
# * Domain of `y`: `[-INFINITY, INFINITY]`.
|
255
|
+
# * Domain of `x`: `[-INFINITY, INFINITY]`.
|
256
|
+
# * Range: `[-PI, PI]`.
|
257
|
+
#
|
258
|
+
# Examples:
|
259
|
+
#
|
260
|
+
# atan2(-1.0, -1.0) # => -2.356194490192345 # -3*PI/4
|
261
|
+
# atan2(-1.0, 0.0) # => -1.5707963267948966 # -PI/2
|
262
|
+
# atan2(-1.0, 1.0) # => -0.7853981633974483 # -PI/4
|
263
|
+
# atan2(0.0, -1.0) # => 3.141592653589793 # PI
|
264
|
+
#
|
265
|
+
def self.atan2: (double y, double x) -> Float
|
107
266
|
|
108
267
|
# <!--
|
109
268
|
# rdoc-file=math.c
|
110
|
-
# - Math.atanh(x)
|
269
|
+
# - Math.atanh(x) -> float
|
111
270
|
# -->
|
112
|
-
#
|
271
|
+
# Returns the [inverse hyperbolic
|
272
|
+
# tangent](https://en.wikipedia.org/wiki/Inverse_hyperbolic_functions) of `x`.
|
113
273
|
#
|
114
|
-
# Domain:
|
274
|
+
# * Domain: `[-1, 1]`.
|
275
|
+
# * Range: `[-INFINITY, INFINITY]`.
|
115
276
|
#
|
116
|
-
#
|
277
|
+
# Examples:
|
117
278
|
#
|
118
|
-
#
|
279
|
+
# atanh(-1.0) # => -Infinity
|
280
|
+
# atanh(0.0) # => 0.0
|
281
|
+
# atanh(1.0) # => Infinity
|
119
282
|
#
|
120
|
-
def self.atanh: (
|
283
|
+
def self.atanh: (double x) -> Float
|
121
284
|
|
122
285
|
# <!--
|
123
286
|
# rdoc-file=math.c
|
124
|
-
# - Math.cbrt(x)
|
287
|
+
# - Math.cbrt(x) -> float
|
125
288
|
# -->
|
126
|
-
# Returns the cube root of `x`.
|
127
|
-
#
|
128
|
-
# Domain:
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
# #
|
138
|
-
# #
|
139
|
-
# #
|
140
|
-
# #
|
141
|
-
# #
|
142
|
-
# #
|
143
|
-
# #
|
144
|
-
#
|
145
|
-
|
146
|
-
# # [2, 1.25992104989487, 2.0]
|
147
|
-
# # [3, 1.44224957030741, 3.0]
|
148
|
-
# # [4, 1.5874010519682, 4.0]
|
149
|
-
# # [5, 1.7099759466767, 5.0]
|
150
|
-
# # [6, 1.81712059283214, 6.0]
|
151
|
-
# # [7, 1.91293118277239, 7.0]
|
152
|
-
# # [8, 2.0, 8.0]
|
153
|
-
# # [9, 2.0800838230519, 9.0]
|
154
|
-
#
|
155
|
-
def self.cbrt: (Numeric x) -> Float
|
289
|
+
# Returns the [cube root](https://en.wikipedia.org/wiki/Cube_root) of `x`.
|
290
|
+
#
|
291
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
292
|
+
# * Range: `[-INFINITY, INFINITY]`.
|
293
|
+
#
|
294
|
+
# Examples:
|
295
|
+
#
|
296
|
+
# cbrt(-INFINITY) # => -Infinity
|
297
|
+
# cbrt(-27.0) # => -3.0
|
298
|
+
# cbrt(-8.0) # => -2.0
|
299
|
+
# cbrt(-2.0) # => -1.2599210498948732
|
300
|
+
# cbrt(1.0) # => 1.0
|
301
|
+
# cbrt(0.0) # => 0.0
|
302
|
+
# cbrt(1.0) # => 1.0
|
303
|
+
# cbrt(2.0) # => 1.2599210498948732
|
304
|
+
# cbrt(8.0) # => 2.0
|
305
|
+
# cbrt(27.0) # => 3.0
|
306
|
+
# cbrt(INFINITY) # => Infinity
|
307
|
+
#
|
308
|
+
def self.cbrt: (double x) -> Float
|
156
309
|
|
157
310
|
# <!--
|
158
311
|
# rdoc-file=math.c
|
159
|
-
# - Math.cos(x)
|
312
|
+
# - Math.cos(x) -> float
|
160
313
|
# -->
|
161
|
-
#
|
162
|
-
#
|
314
|
+
# Returns the [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine) of `x` in
|
315
|
+
# [radians](https://en.wikipedia.org/wiki/Trigonometric_functions#Radians_versus
|
316
|
+
# _degrees).
|
163
317
|
#
|
164
|
-
# Domain: (-INFINITY, INFINITY)
|
318
|
+
# * Domain: `(-INFINITY, INFINITY)`.
|
319
|
+
# * Range: `[-1.0, 1.0]`.
|
165
320
|
#
|
166
|
-
#
|
321
|
+
# Examples:
|
167
322
|
#
|
168
|
-
#
|
323
|
+
# cos(-PI) # => -1.0
|
324
|
+
# cos(-PI/2) # => 6.123031769111886e-17 # 0.0000000000000001
|
325
|
+
# cos(0.0) # => 1.0
|
326
|
+
# cos(PI/2) # => 6.123031769111886e-17 # 0.0000000000000001
|
327
|
+
# cos(PI) # => -1.0
|
169
328
|
#
|
170
|
-
def self.cos: (
|
329
|
+
def self.cos: (double x) -> Float
|
171
330
|
|
172
331
|
# <!--
|
173
332
|
# rdoc-file=math.c
|
174
|
-
# - Math.cosh(x)
|
333
|
+
# - Math.cosh(x) -> float
|
175
334
|
# -->
|
176
|
-
#
|
335
|
+
# Returns the [hyperbolic
|
336
|
+
# cosine](https://en.wikipedia.org/wiki/Hyperbolic_functions) of `x` in
|
337
|
+
# [radians](https://en.wikipedia.org/wiki/Trigonometric_functions#Radians_versus
|
338
|
+
# _degrees).
|
177
339
|
#
|
178
|
-
# Domain:
|
340
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
341
|
+
# * Range: `[1, INFINITY]`.
|
179
342
|
#
|
180
|
-
#
|
343
|
+
# Examples:
|
181
344
|
#
|
182
|
-
#
|
345
|
+
# cosh(-INFINITY) # => Infinity
|
346
|
+
# cosh(0.0) # => 1.0
|
347
|
+
# cosh(INFINITY) # => Infinity
|
183
348
|
#
|
184
|
-
def self.cosh: (
|
349
|
+
def self.cosh: (double x) -> Float
|
185
350
|
|
186
351
|
# <!--
|
187
352
|
# rdoc-file=math.c
|
188
|
-
# - Math.erf(x)
|
353
|
+
# - Math.erf(x) -> float
|
189
354
|
# -->
|
190
|
-
#
|
355
|
+
# Returns the value of the [Gauss error
|
356
|
+
# function](https://en.wikipedia.org/wiki/Error_function) for `x`.
|
357
|
+
#
|
358
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
359
|
+
# * Range: `[-1, 1]`.
|
191
360
|
#
|
192
|
-
#
|
361
|
+
# Examples:
|
193
362
|
#
|
194
|
-
#
|
363
|
+
# erf(-INFINITY) # => -1.0
|
364
|
+
# erf(0.0) # => 0.0
|
365
|
+
# erf(INFINITY) # => 1.0
|
195
366
|
#
|
196
|
-
#
|
367
|
+
# Related: Math.erfc.
|
197
368
|
#
|
198
|
-
def self.erf: (
|
369
|
+
def self.erf: (double x) -> Float
|
199
370
|
|
200
371
|
# <!--
|
201
372
|
# rdoc-file=math.c
|
202
373
|
# - Math.erfc(x) -> Float
|
203
374
|
# -->
|
204
|
-
#
|
375
|
+
# Returns the value of the [complementary error
|
376
|
+
# function](https://en.wikipedia.org/wiki/Error_function#Complementary_error_fun
|
377
|
+
# ction) for `x`.
|
205
378
|
#
|
206
|
-
# Domain:
|
379
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
380
|
+
# * Range: `[0, 2]`.
|
207
381
|
#
|
208
|
-
#
|
382
|
+
# Examples:
|
209
383
|
#
|
210
|
-
#
|
384
|
+
# erfc(-INFINITY) # => 2.0
|
385
|
+
# erfc(0.0) # => 1.0
|
386
|
+
# erfc(INFINITY) # => 0.0
|
211
387
|
#
|
212
|
-
|
388
|
+
# Related: Math.erf.
|
389
|
+
#
|
390
|
+
def self.erfc: (double x) -> Float
|
213
391
|
|
214
392
|
# <!--
|
215
393
|
# rdoc-file=math.c
|
216
|
-
# - Math.exp(x)
|
394
|
+
# - Math.exp(x) -> float
|
217
395
|
# -->
|
218
|
-
# Returns e
|
396
|
+
# Returns `e` raised to the `x` power.
|
219
397
|
#
|
220
|
-
# Domain:
|
398
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
399
|
+
# * Range: `[0, INFINITY]`.
|
221
400
|
#
|
222
|
-
#
|
401
|
+
# Examples:
|
223
402
|
#
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
403
|
+
# exp(-INFINITY) # => 0.0
|
404
|
+
# exp(-1.0) # => 0.36787944117144233 # 1.0/E
|
405
|
+
# exp(0.0) # => 1.0
|
406
|
+
# exp(0.5) # => 1.6487212707001282 # sqrt(E)
|
407
|
+
# exp(1.0) # => 2.718281828459045 # E
|
408
|
+
# exp(2.0) # => 7.38905609893065 # E**2
|
409
|
+
# exp(INFINITY) # => Infinity
|
227
410
|
#
|
228
|
-
def self.exp: (
|
411
|
+
def self.exp: (double x) -> Float
|
229
412
|
|
230
413
|
# <!--
|
231
414
|
# rdoc-file=math.c
|
232
|
-
# - Math.frexp(x)
|
415
|
+
# - Math.frexp(x) -> [fraction, exponent]
|
233
416
|
# -->
|
234
|
-
# Returns a
|
235
|
-
#
|
417
|
+
# Returns a 2-element array containing the normalized signed float `fraction`
|
418
|
+
# and integer `exponent` of `x` such that:
|
419
|
+
#
|
420
|
+
# x = fraction * 2**exponent
|
421
|
+
#
|
422
|
+
# See [IEEE 754 double-precision binary floating-point format:
|
423
|
+
# binary64](https://en.wikipedia.org/wiki/Double-precision_floating-point_format
|
424
|
+
# #IEEE_754_double-precision_binary_floating-point_format:_binary64).
|
425
|
+
#
|
426
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
427
|
+
# * Range `[-INFINITY, INFINITY]`.
|
428
|
+
#
|
429
|
+
# Examples:
|
430
|
+
#
|
431
|
+
# frexp(-INFINITY) # => [-Infinity, -1]
|
432
|
+
# frexp(-2.0) # => [-0.5, 2]
|
433
|
+
# frexp(-1.0) # => [-0.5, 1]
|
434
|
+
# frexp(0.0) # => [0.0, 0]
|
435
|
+
# frexp(1.0) # => [0.5, 1]
|
436
|
+
# frexp(2.0) # => [0.5, 2]
|
437
|
+
# frexp(INFINITY) # => [Infinity, -1]
|
236
438
|
#
|
237
|
-
#
|
238
|
-
# fraction * 2**exponent #=> 1234.0
|
439
|
+
# Related: Math.ldexp (inverse of Math.frexp).
|
239
440
|
#
|
240
|
-
def self.frexp: (
|
441
|
+
def self.frexp: (double x) -> [Float, Integer]
|
241
442
|
|
242
443
|
# <!--
|
243
444
|
# rdoc-file=math.c
|
244
|
-
# - Math.gamma(x)
|
445
|
+
# - Math.gamma(x) -> float
|
245
446
|
# -->
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
253
|
-
#
|
254
|
-
# #
|
255
|
-
# #
|
256
|
-
# #
|
257
|
-
#
|
258
|
-
# #
|
259
|
-
# #
|
260
|
-
# #
|
261
|
-
# #
|
262
|
-
# #
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
266
|
-
|
267
|
-
# # [15, 87178291200.0, 87178291200]
|
268
|
-
# # [16, 1307674368000.0, 1307674368000]
|
269
|
-
# # [17, 20922789888000.0, 20922789888000]
|
270
|
-
# # [18, 355687428096000.0, 355687428096000]
|
271
|
-
# # [19, 6.402373705728e+15, 6402373705728000]
|
272
|
-
# # [20, 1.21645100408832e+17, 121645100408832000]
|
273
|
-
# # [21, 2.43290200817664e+18, 2432902008176640000]
|
274
|
-
# # [22, 5.109094217170944e+19, 51090942171709440000]
|
275
|
-
# # [23, 1.1240007277776077e+21, 1124000727777607680000]
|
276
|
-
# # [24, 2.5852016738885062e+22, 25852016738884976640000]
|
277
|
-
# # [25, 6.204484017332391e+23, 620448401733239439360000]
|
278
|
-
# # [26, 1.5511210043330954e+25, 15511210043330985984000000]
|
279
|
-
#
|
280
|
-
def self.gamma: (Numeric x) -> Float
|
447
|
+
# Returns the value of the [gamma
|
448
|
+
# function](https://en.wikipedia.org/wiki/Gamma_function) for `x`.
|
449
|
+
#
|
450
|
+
# * Domain: `(-INFINITY, INFINITY]` excluding negative integers.
|
451
|
+
# * Range: `[-INFINITY, INFINITY]`.
|
452
|
+
#
|
453
|
+
# Examples:
|
454
|
+
#
|
455
|
+
# gamma(-2.5) # => -0.9453087204829431
|
456
|
+
# gamma(-1.5) # => 2.3632718012073513
|
457
|
+
# gamma(-0.5) # => -3.5449077018110375
|
458
|
+
# gamma(0.0) # => Infinity
|
459
|
+
# gamma(1.0) # => 1.0
|
460
|
+
# gamma(2.0) # => 1.0
|
461
|
+
# gamma(3.0) # => 2.0
|
462
|
+
# gamma(4.0) # => 6.0
|
463
|
+
# gamma(5.0) # => 24.0
|
464
|
+
#
|
465
|
+
# Related: Math.lgamma.
|
466
|
+
#
|
467
|
+
def self.gamma: (double x) -> Float
|
281
468
|
|
282
469
|
# <!--
|
283
470
|
# rdoc-file=math.c
|
284
|
-
# - Math.hypot(
|
471
|
+
# - Math.hypot(a, b) -> float
|
285
472
|
# -->
|
286
|
-
# Returns sqrt(
|
287
|
-
# sides `
|
473
|
+
# Returns `sqrt(a**2 + b**2)`, which is the length of the longest side `c` (the
|
474
|
+
# hypotenuse) of the right triangle whose other sides have lengths `a` and `b`.
|
475
|
+
#
|
476
|
+
# * Domain of `a`: `[-INFINITY, INFINITY]`.
|
477
|
+
# * Domain of +ab: `[-INFINITY, INFINITY]`.
|
478
|
+
# * Range: `[0, INFINITY]`.
|
288
479
|
#
|
289
|
-
#
|
480
|
+
# Examples:
|
290
481
|
#
|
291
|
-
|
482
|
+
# hypot(0.0, 1.0) # => 1.0
|
483
|
+
# hypot(1.0, 1.0) # => 1.4142135623730951 # sqrt(2.0)
|
484
|
+
# hypot(3.0, 4.0) # => 5.0
|
485
|
+
# hypot(5.0, 12.0) # => 13.0
|
486
|
+
# hypot(1.0, sqrt(3.0)) # => 1.9999999999999998 # Near 2.0
|
487
|
+
#
|
488
|
+
# Note that if either argument is `INFINITY` or `-INFINITY`, the result is
|
489
|
+
# `Infinity`.
|
490
|
+
#
|
491
|
+
def self.hypot: (double x, double y) -> Float
|
292
492
|
|
293
493
|
# <!--
|
294
494
|
# rdoc-file=math.c
|
295
495
|
# - Math.ldexp(fraction, exponent) -> float
|
296
496
|
# -->
|
297
|
-
# Returns the value of `fraction
|
497
|
+
# Returns the value of `fraction * 2**exponent`.
|
498
|
+
#
|
499
|
+
# * Domain of `fraction`: `[0.0, 1.0)`.
|
500
|
+
# * Domain of `exponent`: `[0, 1024]` (larger values are equivalent to 1024).
|
501
|
+
#
|
502
|
+
# See [IEEE 754 double-precision binary floating-point format:
|
503
|
+
# binary64](https://en.wikipedia.org/wiki/Double-precision_floating-point_format
|
504
|
+
# #IEEE_754_double-precision_binary_floating-point_format:_binary64).
|
505
|
+
#
|
506
|
+
# Examples:
|
507
|
+
#
|
508
|
+
# ldexp(-INFINITY, -1) # => -Infinity
|
509
|
+
# ldexp(-0.5, 2) # => -2.0
|
510
|
+
# ldexp(-0.5, 1) # => -1.0
|
511
|
+
# ldexp(0.0, 0) # => 0.0
|
512
|
+
# ldexp(-0.5, 1) # => 1.0
|
513
|
+
# ldexp(-0.5, 2) # => 2.0
|
514
|
+
# ldexp(INFINITY, -1) # => Infinity
|
298
515
|
#
|
299
|
-
#
|
300
|
-
# Math.ldexp(fraction, exponent) #=> 1234.0
|
516
|
+
# Related: Math.frexp (inverse of Math.ldexp).
|
301
517
|
#
|
302
|
-
def self.ldexp: (
|
518
|
+
def self.ldexp: (double fraction, int exponent) -> Float
|
303
519
|
|
304
520
|
# <!--
|
305
521
|
# rdoc-file=math.c
|
306
|
-
# - Math.lgamma(x)
|
522
|
+
# - Math.lgamma(x) -> [float, -1 or 1]
|
307
523
|
# -->
|
308
|
-
#
|
524
|
+
# Returns a 2-element array equivalent to:
|
309
525
|
#
|
310
|
-
# Math.lgamma(x) is the same as
|
311
526
|
# [Math.log(Math.gamma(x).abs), Math.gamma(x) < 0 ? -1 : 1]
|
312
527
|
#
|
313
|
-
#
|
528
|
+
# See [logarithmic gamma
|
529
|
+
# function](https://en.wikipedia.org/wiki/Gamma_function#The_log-gamma_function)
|
530
|
+
# .
|
314
531
|
#
|
315
|
-
#
|
532
|
+
# * Domain: `(-INFINITY, INFINITY]`.
|
533
|
+
# * Range of first element: `(-INFINITY, INFINITY]`.
|
534
|
+
# * Second element is -1 or 1.
|
316
535
|
#
|
317
|
-
|
536
|
+
# Examples:
|
537
|
+
#
|
538
|
+
# lgamma(-4.0) # => [Infinity, -1]
|
539
|
+
# lgamma(-3.0) # => [Infinity, -1]
|
540
|
+
# lgamma(-2.0) # => [Infinity, -1]
|
541
|
+
# lgamma(-1.0) # => [Infinity, -1]
|
542
|
+
# lgamma(0.0) # => [Infinity, 1]
|
543
|
+
#
|
544
|
+
# lgamma(1.0) # => [0.0, 1]
|
545
|
+
# lgamma(2.0) # => [0.0, 1]
|
546
|
+
# lgamma(3.0) # => [0.6931471805599436, 1]
|
547
|
+
# lgamma(4.0) # => [1.7917594692280545, 1]
|
548
|
+
#
|
549
|
+
# lgamma(-2.5) # => [-0.05624371649767279, -1]
|
550
|
+
# lgamma(-1.5) # => [0.8600470153764797, 1]
|
551
|
+
# lgamma(-0.5) # => [1.265512123484647, -1]
|
552
|
+
# lgamma(0.5) # => [0.5723649429247004, 1]
|
553
|
+
# lgamma(1.5) # => [-0.12078223763524676, 1]
|
554
|
+
# lgamma(2.5) # => [0.2846828704729205, 1]
|
555
|
+
#
|
556
|
+
# Related: Math.gamma.
|
557
|
+
#
|
558
|
+
def self.lgamma: (double x) -> [Float, -1 | 1]
|
318
559
|
|
319
560
|
# <!--
|
320
561
|
# rdoc-file=math.c
|
321
|
-
# - Math.log(x)
|
322
|
-
# - Math.log(x, base) -> Float
|
562
|
+
# - Math.log(x, base = Math::E) -> Float
|
323
563
|
# -->
|
324
|
-
# Returns the
|
325
|
-
#
|
564
|
+
# Returns the base `base` [logarithm](https://en.wikipedia.org/wiki/Logarithm)
|
565
|
+
# of `x`.
|
566
|
+
#
|
567
|
+
# * Domain: `[0, INFINITY]`.
|
568
|
+
# * Range: `[-INFINITY, INFINITY)]`.
|
326
569
|
#
|
327
|
-
#
|
570
|
+
# Examples:
|
328
571
|
#
|
329
|
-
#
|
572
|
+
# log(0.0) # => -Infinity
|
573
|
+
# log(1.0) # => 0.0
|
574
|
+
# log(E) # => 1.0
|
575
|
+
# log(INFINITY) # => Infinity
|
330
576
|
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
# Math.log(Math::E**3) #=> 3.0
|
335
|
-
# Math.log(12, 3) #=> 2.2618595071429146
|
577
|
+
# log(0.0, 2.0) # => -Infinity
|
578
|
+
# log(1.0, 2.0) # => 0.0
|
579
|
+
# log(2.0, 2.0) # => 1.0
|
336
580
|
#
|
337
|
-
|
581
|
+
# log(0.0, 10.0) # => -Infinity
|
582
|
+
# log(1.0, 10.0) # => 0.0
|
583
|
+
# log(10.0, 10.0) # => 1.0
|
584
|
+
#
|
585
|
+
def self.log: (double x, ?double base) -> Float
|
338
586
|
|
339
587
|
# <!--
|
340
588
|
# rdoc-file=math.c
|
341
|
-
# - Math.log10(x)
|
589
|
+
# - Math.log10(x) -> float
|
342
590
|
# -->
|
343
|
-
# Returns the base 10 logarithm of
|
591
|
+
# Returns the base 10 [logarithm](https://en.wikipedia.org/wiki/Logarithm) of
|
592
|
+
# `x`.
|
344
593
|
#
|
345
|
-
# Domain:
|
594
|
+
# * Domain: `[0, INFINITY]`.
|
595
|
+
# * Range: `[-INFINITY, INFINITY]`.
|
346
596
|
#
|
347
|
-
#
|
597
|
+
# Examples:
|
348
598
|
#
|
349
|
-
#
|
350
|
-
#
|
351
|
-
#
|
599
|
+
# log10(0.0) # => -Infinity
|
600
|
+
# log10(1.0) # => 0.0
|
601
|
+
# log10(10.0) # => 1.0
|
602
|
+
# log10(INFINITY) # => Infinity
|
352
603
|
#
|
353
|
-
def self.log10: (
|
604
|
+
def self.log10: (double x) -> Float
|
354
605
|
|
355
606
|
# <!--
|
356
607
|
# rdoc-file=math.c
|
357
|
-
# - Math.log2(x)
|
608
|
+
# - Math.log2(x) -> float
|
358
609
|
# -->
|
359
|
-
# Returns the base 2 logarithm of
|
610
|
+
# Returns the base 2 [logarithm](https://en.wikipedia.org/wiki/Logarithm) of
|
611
|
+
# `x`.
|
360
612
|
#
|
361
|
-
# Domain:
|
613
|
+
# * Domain: `[0, INFINITY]`.
|
614
|
+
# * Range: `[-INFINITY, INFINITY]`.
|
362
615
|
#
|
363
|
-
#
|
616
|
+
# Examples:
|
364
617
|
#
|
365
|
-
#
|
366
|
-
#
|
367
|
-
#
|
368
|
-
#
|
618
|
+
# log2(0.0) # => -Infinity
|
619
|
+
# log2(1.0) # => 0.0
|
620
|
+
# log2(2.0) # => 1.0
|
621
|
+
# log2(INFINITY) # => Infinity
|
369
622
|
#
|
370
|
-
def self.log2: (
|
623
|
+
def self.log2: (double x) -> Float
|
371
624
|
|
372
625
|
# <!--
|
373
626
|
# rdoc-file=math.c
|
374
|
-
# - Math.sin(x)
|
627
|
+
# - Math.sin(x) -> float
|
375
628
|
# -->
|
376
|
-
#
|
377
|
-
#
|
629
|
+
# Returns the [sine](https://en.wikipedia.org/wiki/Sine_and_cosine) of `x` in
|
630
|
+
# [radians](https://en.wikipedia.org/wiki/Trigonometric_functions#Radians_versus
|
631
|
+
# _degrees).
|
378
632
|
#
|
379
|
-
# Domain: (-INFINITY, INFINITY)
|
633
|
+
# * Domain: `(-INFINITY, INFINITY)`.
|
634
|
+
# * Range: `[-1.0, 1.0]`.
|
380
635
|
#
|
381
|
-
#
|
636
|
+
# Examples:
|
382
637
|
#
|
383
|
-
#
|
638
|
+
# sin(-PI) # => -1.2246063538223773e-16 # -0.0000000000000001
|
639
|
+
# sin(-PI/2) # => -1.0
|
640
|
+
# sin(0.0) # => 0.0
|
641
|
+
# sin(PI/2) # => 1.0
|
642
|
+
# sin(PI) # => 1.2246063538223773e-16 # 0.0000000000000001
|
384
643
|
#
|
385
|
-
def self.sin: (
|
644
|
+
def self.sin: (double x) -> Float
|
386
645
|
|
387
646
|
# <!--
|
388
647
|
# rdoc-file=math.c
|
389
|
-
# - Math.sinh(x)
|
648
|
+
# - Math.sinh(x) -> float
|
390
649
|
# -->
|
391
|
-
#
|
650
|
+
# Returns the [hyperbolic
|
651
|
+
# sine](https://en.wikipedia.org/wiki/Hyperbolic_functions) of `x` in
|
652
|
+
# [radians](https://en.wikipedia.org/wiki/Trigonometric_functions#Radians_versus
|
653
|
+
# _degrees).
|
392
654
|
#
|
393
|
-
# Domain:
|
655
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
656
|
+
# * Range: `[-INFINITY, INFINITY]`.
|
394
657
|
#
|
395
|
-
#
|
658
|
+
# Examples:
|
396
659
|
#
|
397
|
-
#
|
660
|
+
# sinh(-INFINITY) # => -Infinity
|
661
|
+
# sinh(0.0) # => 0.0
|
662
|
+
# sinh(INFINITY) # => Infinity
|
398
663
|
#
|
399
|
-
def self.sinh: (
|
664
|
+
def self.sinh: (double x) -> Float
|
400
665
|
|
401
666
|
# <!--
|
402
667
|
# rdoc-file=math.c
|
403
|
-
# - Math.sqrt(x)
|
668
|
+
# - Math.sqrt(x) -> float
|
404
669
|
# -->
|
405
|
-
# Returns the non-negative square
|
406
|
-
#
|
407
|
-
# Domain: [0, INFINITY)
|
408
|
-
#
|
409
|
-
# Codomain:[0, INFINITY)
|
670
|
+
# Returns the principal (non-negative) [square
|
671
|
+
# root](https://en.wikipedia.org/wiki/Square_root) of `x`.
|
410
672
|
#
|
411
|
-
#
|
412
|
-
#
|
413
|
-
# }
|
414
|
-
# #=> [0, 0.0, 0.0]
|
415
|
-
# # [1, 1.0, 1.0]
|
416
|
-
# # [2, 1.4142135623731, 2.0]
|
417
|
-
# # [3, 1.73205080756888, 3.0]
|
418
|
-
# # [4, 2.0, 4.0]
|
419
|
-
# # [5, 2.23606797749979, 5.0]
|
420
|
-
# # [6, 2.44948974278318, 6.0]
|
421
|
-
# # [7, 2.64575131106459, 7.0]
|
422
|
-
# # [8, 2.82842712474619, 8.0]
|
423
|
-
# # [9, 3.0, 9.0]
|
424
|
-
# # [10, 3.16227766016838, 10.0]
|
673
|
+
# * Domain: `[0, INFINITY]`.
|
674
|
+
# * Range: `[0, INFINITY]`.
|
425
675
|
#
|
426
|
-
#
|
427
|
-
# surprising results:
|
676
|
+
# Examples:
|
428
677
|
#
|
429
|
-
#
|
678
|
+
# sqrt(0.0) # => 0.0
|
679
|
+
# sqrt(0.5) # => 0.7071067811865476
|
680
|
+
# sqrt(1.0) # => 1.0
|
681
|
+
# sqrt(2.0) # => 1.4142135623730951
|
682
|
+
# sqrt(4.0) # => 2.0
|
683
|
+
# sqrt(9.0) # => 3.0
|
684
|
+
# sqrt(INFINITY) # => Infinity
|
430
685
|
#
|
431
|
-
|
432
|
-
#
|
433
|
-
def self.sqrt: (Numeric x) -> Float
|
686
|
+
def self.sqrt: (double x) -> Float
|
434
687
|
|
435
688
|
# <!--
|
436
689
|
# rdoc-file=math.c
|
437
|
-
# - Math.tan(x)
|
690
|
+
# - Math.tan(x) -> float
|
438
691
|
# -->
|
439
|
-
#
|
692
|
+
# Returns the [tangent](https://en.wikipedia.org/wiki/Trigonometric_functions)
|
693
|
+
# of `x` in
|
694
|
+
# [radians](https://en.wikipedia.org/wiki/Trigonometric_functions#Radians_versus
|
695
|
+
# _degrees).
|
440
696
|
#
|
441
|
-
# Domain: (-INFINITY, INFINITY)
|
697
|
+
# * Domain: `(-INFINITY, INFINITY)`.
|
698
|
+
# * Range: `(-INFINITY, INFINITY)`.
|
442
699
|
#
|
443
|
-
#
|
700
|
+
# Examples:
|
444
701
|
#
|
445
|
-
#
|
702
|
+
# tan(-PI) # => 1.2246467991473532e-16 # -0.0000000000000001
|
703
|
+
# tan(-PI/2) # => -1.633123935319537e+16 # -16331239353195370.0
|
704
|
+
# tan(0.0) # => 0.0
|
705
|
+
# tan(PI/2) # => 1.633123935319537e+16 # 16331239353195370.0
|
706
|
+
# tan(PI) # => -1.2246467991473532e-16 # -0.0000000000000001
|
446
707
|
#
|
447
|
-
def self.tan: (
|
708
|
+
def self.tan: (double x) -> Float
|
448
709
|
|
449
710
|
# <!--
|
450
711
|
# rdoc-file=math.c
|
451
|
-
# - Math.tanh(x)
|
712
|
+
# - Math.tanh(x) -> float
|
452
713
|
# -->
|
453
|
-
#
|
714
|
+
# Returns the [hyperbolic
|
715
|
+
# tangent](https://en.wikipedia.org/wiki/Hyperbolic_functions) of `x` in
|
716
|
+
# [radians](https://en.wikipedia.org/wiki/Trigonometric_functions#Radians_versus
|
717
|
+
# _degrees).
|
454
718
|
#
|
455
|
-
# Domain:
|
719
|
+
# * Domain: `[-INFINITY, INFINITY]`.
|
720
|
+
# * Range: `[-1, 1]`.
|
456
721
|
#
|
457
|
-
#
|
722
|
+
# Examples:
|
458
723
|
#
|
459
|
-
#
|
724
|
+
# tanh(-INFINITY) # => -1.0
|
725
|
+
# tanh(0.0) # => 0.0
|
726
|
+
# tanh(INFINITY) # => 1.0
|
460
727
|
#
|
461
|
-
def self.tanh: (
|
462
|
-
end
|
463
|
-
|
464
|
-
# <!-- rdoc-file=math.c -->
|
465
|
-
# Definition of the mathematical constant E for Euler's number (e) as a Float
|
466
|
-
# number.
|
467
|
-
#
|
468
|
-
Math::E: Float
|
469
|
-
|
470
|
-
# <!-- rdoc-file=math.c -->
|
471
|
-
# Definition of the mathematical constant PI as a Float number.
|
472
|
-
#
|
473
|
-
Math::PI: Float
|
474
|
-
|
475
|
-
# <!-- rdoc-file=math.c -->
|
476
|
-
# Raised when a mathematical function is evaluated outside of its domain of
|
477
|
-
# definition.
|
478
|
-
#
|
479
|
-
# For example, since `cos` returns values in the range -1..1, its inverse
|
480
|
-
# function `acos` is only defined on that interval:
|
481
|
-
#
|
482
|
-
# Math.acos(42)
|
483
|
-
#
|
484
|
-
# *produces:*
|
485
|
-
#
|
486
|
-
# Math::DomainError: Numerical argument is out of domain - "acos"
|
487
|
-
#
|
488
|
-
class Math::DomainError < StandardError
|
728
|
+
def self.tanh: (double x) -> Float
|
489
729
|
end
|