vector_number 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b935cacefb185478f7f923046b28589c6da2763574c315f19c6b8050cd5835e1
-  data.tar.gz: a93dd71a4de2d07255962e13a81a357c92f5a1653d916e95d5a54a99afa984a6
+  metadata.gz: 3958070d42eb34b2a76467cda30a4c33e90838a17211d06bf9088311f6cf82ee
+  data.tar.gz: 5308af739c073e2193ee8199a1118eef011e0aa552cbcceb6a8bae63f8c2da5d
 SHA512:
-  metadata.gz: 9d6ea64b09d12434470d65c7ff808b63b9ccc59cb1e479bc7659ed973a8f03a3fb137dfe3641163dc56b06163b7d0c472ed74af2f49f6623b866eff90961aa7c
-  data.tar.gz: 85a927c88c99533e434a185a239f2d129567adf8d2e8c4d8d62e6239560d889e24fc7d3e478039b6d8c4213596e9ea7a61da5d0ab867162f9fbe7bee4edf05e5
+  metadata.gz: 515c092ebe57230a92fff99868ccf7fd929fcf9a2aa6d81b10918c68108010b55214bc88fef0112659b513623959c82fd6e8431fbaf16e1917e25d1b07a797a7
+  data.tar.gz: 9738e48084961b2ac7a6e02853ca30c37d736692ac14b3e49ac72f8adea3a31ebc72ea1751e474c57007ef1aa9d3663aa61a2de3ac3b937192c7ae7bd680a6e4

data/CHANGELOG.md

@@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Next]
+## [v0.4.0] — 2025-07-07
+
+**Changed**
+- [🍄 BREAKING] Change `R` and `I` constants to be `1` and `2` instead of `0i` and `1i` respectively.
+   Their values are still semi-private and should not be relied on.
+- [🍄 BREAKING] Calling `new` with an unsupported value now raises `ArgumentError` instead of treating it like air.
+- Optimize various initialization paths. It is now 1.5-2.5 times faster, depending on arguments.
+- [🚀 CI] Disable JRuby testing on CI.
+
+[Compare v0.3.1...main](https://github.com/trinistr/vector_number/compare/v0.3.1...main)
+
 ## [v0.3.1] — 2025-06-21
 
 This is mostly a documentation update with a side of improved gemspec.
@@ -23,7 +34,7 @@ This is mostly a documentation update with a side of improved gemspec.
 **Fixed**
 - Correct broken changelog link in gem metadata.
 
-[Compare v0.3.0...main](https://github.com/trinistr/vector_number/compare/v0.3.0...main)
+[Compare v0.3.0...v0.3.1](https://github.com/trinistr/vector_number/compare/v0.3.0...v0.3.1)
 
 ## [v0.3.0] — 2025-05-12
 
@@ -33,7 +44,7 @@ This is mostly a documentation update with a side of improved gemspec.
    `#+@` was already practically aliased by `#dup`.
 
 **Changed**
-- [Breaking] Long-existing but broken options feature is now fixed.
+- [🍄 BREAKING] Long-existing but broken options feature is now fixed.
    When creating new vector through any operation, participating vector's options
    are copied to the new one. When several vectors are present, only first one matters.
 - Both `#+@` and `#dup` are now aliases of `#itself` instead of full methods.
@@ -70,7 +81,7 @@ README was updated to reflect this change.
 - Add hash-like methods `#[]` and `#unit?` (aliased as `#key?`).
 
 **Changed**
-- [Breaking] Change `positive?` and `negative?` to no longer return `nil`
+- [🍄 BREAKING] Change `positive?` and `negative?` to no longer return `nil`
    when number is neither strictly positive or negative,
    these cases will now return `false`.
 - Make `VectorNumber.new` accept options when initializing from a VectorNumber
@@ -138,6 +149,7 @@ README was updated to reflect this change.
 - Initial work.
 
 [Next]: https://github.com/trinistr/vector_number/tree/main
+[v0.3.1]: https://github.com/trinistr/vector_number/tree/v0.3.1
 [v0.3.0]: https://github.com/trinistr/vector_number/tree/v0.3.0
 [v0.2.6]: https://github.com/trinistr/vector_number/tree/v0.2.6
 [v0.2.5]: https://github.com/trinistr/vector_number/tree/v0.2.5

data/README.md

@@ -52,8 +52,8 @@ VectorNumbers are mostly useful for summing up heterogeneous objects:
 sum = VectorNumber[]
 [4, "death", "death", 13, nil].each { sum = sum + _1 }
 sum # => (17 + 2⋅'death' + 1⋅)
-sum.to_a # => [[(0+0i), 17], ["death", 2], [nil, 1]]
-sum.to_h # => {(0+0i)=>17, "death"=>2, nil=>1}
+sum.to_a # => [[1, 17], ["death", 2], [nil, 1]]
+sum.to_h # => {1=>17, "death"=>2, nil=>1}
 ```
 
 Alternatively, the same result can be equivalently (and more efficiently) achieved by
@@ -67,7 +67,7 @@ VectorNumber.new([4, "death", "death", 13, nil])
 
 VectorNumber is developed on MRI (CRuby) but should work on other engines too.
 - TruffleRuby: works as expected, but there are differences in core Ruby code, so some tests fail.
-- JRuby: significant problems (at least on CI), but may work.
+- JRuby: significant problems, but may work, currently not tested.
 - Other engines: untested, but should work, depending on compatibility.
 
 ## Development

data/lib/vector_number/comparing.rb

@@ -85,7 +85,7 @@ class VectorNumber
     #   VectorNumber["a"] <=> 2 # => nil
     #
     # @param other [Object]
-    # @return [-1, 0, 1]
+    # @return [Integer]
     # @return [nil] if +self+ or +other+ isn't a real number.
     #
     # @see Comparable

data/lib/vector_number/enumerating.rb

@@ -21,7 +21,7 @@ class VectorNumber
     #   units # => ["a", "b"]
     # @example Enumerator
     #   v.each.size # => 3
-    #   (v.each + [["d", 0]]).map(&:first) # => ["a", "b", (0+0i), "d"]
+    #   (v.each + [["d", 0]]).map(&:first) # => ["a", "b", 1, "d"]
     #   v.each_pair.peek # => ["a", 1]
     #
     # @overload each
@@ -49,7 +49,7 @@ class VectorNumber
     # Get a list of units with non-zero coefficients.
     #
     # @example
-    #   VectorNumber["a", "b", 6].units # => ["a", "b", (0+0i)]
+    #   VectorNumber["a", "b", 6].units # => ["a", "b", 1]
     #   VectorNumber.new.keys # => []
     #
     # @return [Array<Object>]
@@ -79,7 +79,7 @@ class VectorNumber
     # Returned hash has a default value of 0.
     #
     # @example
-    #   VectorNumber["a", "b", 6].to_h # => {"a"=>1, "b"=>1, (0+0i)=>6}
+    #   VectorNumber["a", "b", 6].to_h # => {"a"=>1, "b"=>1, 1=>6}
     #   VectorNumber["a", "b", 6].to_h["c"] # => 0
     #
     # @return [Hash{Object => Integer, Float, Rational, BigDecimal}]

data/lib/vector_number/version.rb

@@ -2,5 +2,5 @@
 
 class VectorNumber
   # @return [String]
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/vector_number.rb

@@ -37,7 +37,7 @@ class VectorNumber
   # Get a unit for +n+th numeric dimension, where 1 is real, 2 is imaginary.
   #
   # @since 0.2.0
-  UNIT = ->(n) { (n - 1).i }.freeze
+  UNIT = ->(n) { n }.freeze
   # Constant for real unit.
   #
   # @since 0.2.0
@@ -97,9 +97,9 @@ class VectorNumber
   #   VectorNumber.new(["a", "b", "c", 3], &:-@) # => (-1⋅'a' - 1⋅'b' - 1⋅'c' - 3)
   #   VectorNumber.new(["a", "b", "c", 3], &:digits) # RangeError
   #
-  # @param values [Array, Hash{Object => Integer, Float, Rational, BigDecimal}, VectorNumber]
+  # @param values [Array, VectorNumber, Hash{Object => Integer, Float, Rational, BigDecimal}, nil]
   #   values for this number, hashes are treated like plain vector numbers
-  # @param options [Hash{Symbol => Object}]
+  # @param options [Hash{Symbol => Object}, nil]
   #   options for this number, if +values+ is a VectorNumber or contains it,
   #   these will be merged with options from its +options+
   # @option options [Symbol, String] :mult
@@ -173,15 +173,18 @@ class VectorNumber
   #
   # @since 0.1.0
   def initialize_from(values)
-    @data = Hash.new(0)
+    @data = values.to_h and return if values.is_a?(VectorNumber)
 
+    @data = Hash.new(0)
     case values
-    when VectorNumber, Hash
-      add_vector_to_data(values)
     when Array
       values.each { |value| add_value_to_data(value) }
+    when Hash
+      add_vector_to_data(values)
+    when nil
+      # Do nothing, as there are no values.
     else
-      # Don't add anything.
+      raise ArgumentError, "unsupported type for values: #{values.class}"
     end
   end
 
@@ -206,7 +209,9 @@ class VectorNumber
   # @since 0.1.0
   def add_numeric_value_to_data(value)
     @data[R] += value.real
-    @data[I] += value.imaginary
+    # Most numbers will be real, and this extra condition appreciably speeds up addition,
+    # while having no noticeable impact on complex numbers.
+    @data[I] += value.imaginary unless value.real?
   end
 
   # @param vector [VectorNumber, Hash{Object => Integer, Float, Rational, BigDecimal}]
@@ -245,32 +250,27 @@ class VectorNumber
   # @since 0.1.0
   def save_options(options, values:)
     @options =
-      case [options, values]
-      in [{} | nil, VectorNumber]
-        values.options
-      in [{} | nil, [*, VectorNumber => vector, *]]
-        vector.options
-      in Hash, VectorNumber
+      case values
+      in VectorNumber
         merge_options(values.options, options)
-      in Hash, [*, VectorNumber => vector, *]
+      in Array[*, VectorNumber => vector, *]
         merge_options(vector.options, options)
-      in Hash, _ unless options.empty?
-        merge_options(default_options, options)
       else
-        default_options
+        merge_options(DEFAULT_OPTIONS, options)
       end
   end
 
   # @param base_options [Hash{Symbol => Object}]
-  # @param added_options [Hash{Symbol => Object}]
+  # @param added_options [Hash{Symbol => Object}, nil]
   # @return [Hash{Symbol => Object}]
   #
   # @since 0.3.0
   def merge_options(base_options, added_options)
+    return base_options if !added_options || added_options.empty?
     # Optimization for the common case of passing options through #new.
     return base_options if added_options.equal?(base_options)
 
-    base_options.merge(added_options).slice(*known_options)
+    base_options.merge(added_options).slice(*KNOWN_OPTIONS)
   end
 
   # Compact coefficients, calculate size and freeze data.
@@ -282,14 +282,4 @@ class VectorNumber
     @data.freeze
     @size = @data.size
   end
-
-  # @since 0.2.0
-  def default_options
-    DEFAULT_OPTIONS
-  end
-
-  # @since 0.2.0
-  def known_options
-    KNOWN_OPTIONS
-  end
 end

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: vector_number
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Alexandr Bulancov
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-07-07 00:00:00.000000000 Z
 dependencies: []
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files:
+- README.md
 - CHANGELOG.md
 - LICENSE.txt
-- README.md
 files:
 - CHANGELOG.md
 - LICENSE.txt
@@ -36,10 +39,11 @@ licenses:
 metadata:
   homepage_uri: https://github.com/trinistr/vector_number
   bug_tracker_uri: https://github.com/trinistr/vector_number/issues
-  documentation_uri: https://rubydoc.info/gems/vector_number/0.3.1
-  source_code_uri: https://github.com/trinistr/vector_number/tree/v0.3.1
-  changelog_uri: https://github.com/trinistr/vector_number/blob/v0.3.1/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/vector_number/0.4.0
+  source_code_uri: https://github.com/trinistr/vector_number/tree/v0.4.0
+  changelog_uri: https://github.com/trinistr/vector_number/blob/v0.4.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -58,7 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: A library to add together anything.
 test_files: []