vector_number 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8fc99d66449b0cbc1ac4f2871e540ff921dee5d291b487221193edaefca1b2f
-  data.tar.gz: 38f15f406bff5348debb50b5468bf416e2fd3bca4be69257e3b59b99fbebd6ed
+  metadata.gz: c55a93e873d8e98092a5be77940f3f91cf06e90abb973f16d2fc91f0df0276ca
+  data.tar.gz: 446cb27d60ff3b588ffbc6fa49489013d6a2cfc8e6f2b577abc4a40b47587658
 SHA512:
-  metadata.gz: 23f819566a189655bcefaa7d22005e7de4e7349ad99718497e13faf97a748d6c9c63788146379473d28caed9bc7063a13787074f0c87241a1a36859a30a126a7
-  data.tar.gz: 33c4ce966c7ce9d3d1a486acd6119af50d9458c8048e2a6f07348625bb50bcb11d1db50c8dbee75ba81be996afe53bcb25af2b356ab9be0e1a6689a67d3a14dd
+  metadata.gz: 2a069408f786816659721505e8e09d50aeaf891e6dcc85c35d008a161500548e74c3cb0224a8992521c3e9385cb8cabe6c9b565874981c0098d5fb5c081ee65f
+  data.tar.gz: 99c2b90210dfceaeec85f6f8fd897074296c27ba6e9a6cb8ffcd0d407b3f65482b445b721fd5a41139a339d5d54f8ce81f4860dfdffccc0db1909002744fa8fe

data/CHANGELOG.md

@@ -6,6 +6,33 @@ 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.3.0] — 2025-05-12
+
+**Added**
+- Add aliases to other operators:
+   `#neg` for `#-@`, `#add` for `#+`, `#sub` for `#-`, `#mult` for `#*`.
+   `#+@` was already practically aliased by `#dup`.
+
+**Changed**
+- [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.
+- [🚀 CI] Refactor workflows to reduce duplication.
+
+## [v0.2.6] — 2025-04-30
+
+**Added**
+- Add `#div`, `#%` (aliased as `#modulo`), `#divmod` and `#remainder` methods.
+- Add `#quo` alias to `#/`.
+
+**Fixed**
+- `#/`, `#fdiv` as well as new division methods now properly check for division by zero.
+   VectorNumber does not support this as not all Numeric classes do.
+
+**Changed**
+- [🚀 CI] Add Ruby 3.4 to CI.
+
 ## [v0.2.5] — 2025-02-26
 
 Technical update after release to rubygems.org.
@@ -17,12 +44,13 @@ 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`,
-   those cases will now return `false`.
+- [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
    instead of only copying. Options will be merged.
 - Remove `Initializing` module, move its methods to the actual class.
-- Updated development gem versions.
+- Update development gems' versions.
 
 **Fixed**
 - `#dup` and `#clone` now behave exactly like Numeric versions, preventing unfreezing.
@@ -39,9 +67,9 @@ README was updated to reflect this change.
 - Add `#ceil`, `#floor` and `#round`.
 
 **Changed**
-- Add ruby 3.1.0, covering the earliest supported version, and ruby-next (3.4) to CI.
-- Add JRuby and TruffleRuby to CI, without full support.
-- Make tests runnable even without available `bigdecimal` gem.
+- [🚀 CI] Add ruby 3.1.0, covering the earliest supported version, and ruby-next (3.4) to CI.
+- [🚀 CI] Add JRuby and TruffleRuby to CI, without full support.
+- [🚀 CI] Make tests runnable even without available `bigdecimal` gem.
 
 **Fixed**
 - `Kernel#BigDecimal` refinement now correctly works without `ndigits` argument.
@@ -49,7 +77,7 @@ README was updated to reflect this change.
 ## [v0.2.1] — 2024-08-24
 
 **Added**
-- Add back `#*` and `#/` for working with real numbers.
+- Add `#*` and `#/` for working with real numbers.
 - Add `#fdiv`, `#truncate`, `#nonnumeric?` and `#integer?`.
 
 **Changed**
@@ -72,3 +100,5 @@ README was updated to reflect this change.
 ## [v0.1.0] — 2024-05-09
 
 - Initial work.
+
+[🚀 CI]: https://github.com/trinistr/vector_number/actions/workflows/CI.yaml

data/README.md

@@ -1,9 +1,6 @@
 # VectorNumber
 
-![CRuby validation](https://github.com/trinistr/vector_number/actions/workflows/cruby.yaml/badge.svg)
-<!--
-![TruffleRuby validation](https://github.com/trinistr/vector_number/actions/workflows/truffleruby.yaml/badge.svg)
--->
+[![CI](https://github.com/trinistr/vector_number/actions/workflows/CI.yaml/badge.svg)](https://github.com/trinistr/vector_number/actions/workflows/CI.yaml)
 
 A library to add together anything: be it a number, string or random Object, it can be added together in an infinite-dimensional vector space, with math operations available on results.
 
@@ -16,7 +13,9 @@ Similar projects:
 
 ## Installation
 
-Install with `gem`:
+VectorNumber does not have any dependencies and does not include extensions.
+
+Install with `gem` (available from 0.2.4):
 ```sh
 gem install vector_number
 ```
@@ -58,9 +57,9 @@ VectorNumber.new([4, "death", "death", 13, nil])
 ## Ruby engine support status
 
 VectorNumber is developed on MRI (CRuby) but should work on other engines too.
-- JRuby: should work, but currently CI does not pass.
 - TruffleRuby: works as expected, but there are differences in core Ruby code, so some tests fail.
-- Other engines: untested, but should work.
+- JRuby: significant problems (at least on CI), but may work.
+- Other engines: untested, but should work, depending on compatibility.
 
 ## Development
 

data/lib/vector_number/math_converting.rb

@@ -3,10 +3,10 @@
 class VectorNumber
   # Various mathematical operations that are also conversions.
   module MathConverting
-    # Return the absolute value of a vector, i.e. its length.
+    # Return the absolute value of the vector, i.e. its length.
     # @return [Float]
     def abs
-      Math.sqrt(coefficients.reduce(0.0) { |result, coefficient| result + coefficient.abs2 })
+      Math.sqrt(coefficients.sum(&:abs2)) # rubocop:disable Naming/VariableNumber
     end
 
     alias magnitude abs

data/lib/vector_number/mathing.rb

@@ -18,9 +18,7 @@ class VectorNumber
 
     # Return self.
     # @return [VectorNumber]
-    def +@
-      self
-    end
+    alias +@ itself
 
     # Return new vector with negated coefficients.
     # This preserves order of units.
@@ -29,6 +27,8 @@ class VectorNumber
       new(&:-@)
     end
 
+    alias neg -@
+
     # Return new vector as a sum of this and other value.
     # This is analogous to {VectorNumber.[]}.
     # @param other [Object]
@@ -37,6 +37,8 @@ class VectorNumber
       new([self, other])
     end
 
+    alias add +
+
     # Return new vector as a sum of this and negative of the other value.
     # This is analogous to {VectorNumber.[]}, but allows to negate anything.
     # @param other [Object]
@@ -45,6 +47,8 @@ class VectorNumber
       self + new([other], &:-@)
     end
 
+    alias sub -
+
     # Multiply all coefficients by a real number, returning new vector.
     # This effectively multiplies magnitude by the specified factor.
     # @param other [Integer, Float, Rational, BigDecimal, VectorNumber]
@@ -63,13 +67,16 @@ class VectorNumber
       end
     end
 
+    alias mult *
+
     # Divide all coefficients by a real number, returning new vector.
-    # This effectively multiplies magnitude by reciprocal of the specified factor.
+    # This effectively multiplies magnitude by reciprocal of +other+.
     # @param other [Integer, Float, Rational, BigDecimal, VectorNumber]
     # @return [VectorNumber]
     # @raise [RangeError] if +other+ is not a number or is not a real number
+    # @raise [ZeroDivisionError] if +other+ is zero
     def /(other)
-      raise RangeError, "can't divide #{self} by #{other}" unless real_number?(other)
+      check_divisibility(other)
 
       other = other.real
       # Prevent integer division, but without loss of accuracy.
@@ -78,16 +85,87 @@ class VectorNumber
       new { _1 / other }
     end
 
+    alias quo /
+
     # Divide all coefficients by a real number using +fdiv+, returning new vector
     # with Float coefficients.
     # @param other [Integer, Float, Rational, BigDecimal, VectorNumber]
     # @return [VectorNumber]
     # @raise [RangeError] if +other+ is not a number or is not a real number
+    # @raise [ZeroDivisionError] if +other+ is zero
     def fdiv(other)
-      raise RangeError, "can't divide #{self} by #{other}" unless real_number?(other)
+      check_divisibility(other)
 
       other = other.real
       new { _1.fdiv(other) }
     end
+
+    # Divide all coefficients by +other+, rounding results with {#floor}.
+    # This is requal to +(self / other).floor+.
+    # @param other [Integer, Float, Rational, BigDecimal, VectorNumber]
+    # @return [VectorNumber]
+    # @raise [RangeError] if +other+ is not a number or is not a real number
+    # @raise [ZeroDivisionError] if +other+ is zero
+    # @see #divmod
+    # @see #%
+    def div(other)
+      check_divisibility(other)
+
+      other = other.real
+      new { _1.div(other) }
+    end
+
+    # Return the modulus of dividing self by +other+ as a vector.
+    # This is equal to +self - other * (self/other).floor+.
+    # @param other [Integer, Float, Rational, BigDecimal, VectorNumber]
+    # @return [VectorNumber]
+    # @raise [RangeError] if +other+ is not a number or is not a real number
+    # @raise [ZeroDivisionError] if +other+ is zero
+    # @see #divmod
+    # @see #div
+    # @see #remainder for alternative
+    # @see Numeric#% for examples
+    def %(other)
+      check_divisibility(other)
+
+      other = other.real
+      new { _1 % other }
+    end
+
+    alias modulo %
+
+    # Return the quotient and modulus of dividing self by +other+.
+    # There is no performance benefit compared to calling {#div} and {#%} separately.
+    # @param other [Integer, Float, Rational, BigDecimal, VectorNumber]
+    # @return [Array(VectorNumber, VectorNumber)]
+    # @raise [RangeError] if +other+ is not a number or is not a real number
+    # @raise [ZeroDivisionError] if +other+ is zero
+    # @see #div
+    # @see #%
+    def divmod(other)
+      [div(other), modulo(other)]
+    end
+
+    # Return the remainder of dividing self by +other+ as a vector.
+    # This is equal to +self - other * (self/other).truncate+.
+    # @param other [Integer, Float, Rational, BigDecimal, VectorNumber]
+    # @return [VectorNumber]
+    # @raise [RangeError] if +other+ is not a number or is not a real number
+    # @raise [ZeroDivisionError] if +other+ is zero
+    # @see #% for alternative
+    # @see Numeric#remainder for examples
+    def remainder(other)
+      check_divisibility(other)
+
+      other = other.real
+      new { _1.remainder(other) }
+    end
+
+    private
+
+    def check_divisibility(other)
+      raise RangeError, "can't divide #{self} by #{other}", caller unless real_number?(other)
+      raise ZeroDivisionError, "divided by 0", caller if other.zero?
+    end
   end
 end

data/lib/vector_number/querying.rb

@@ -65,14 +65,14 @@ class VectorNumber
       !zero? && all? { |_u, c| c.negative? }
     end
 
-    # Always returns +false+.
+    # Always returns +false+, as vectors are never real numbers.
     # @see #numeric?
     # @return [false]
     def real?
       false
     end
 
-    # Always returns +false+.
+    # Always returns +false+, as vectors are not +Integer+s.
     # @return [false]
     def integer?
       false

data/lib/vector_number/stringifying.rb

@@ -36,6 +36,7 @@ class VectorNumber
 
     # @return [String]
     def inspect
+      # TODO: Probably make this independent of options.
       "(#{self})"
     end
 
@@ -48,7 +49,7 @@ class VectorNumber
     # @raise [ArgumentError] if +mult+ is not in {MULT_STRINGS}'s keys
     def value_to_s(unit, coefficient, mult:)
       if !mult.is_a?(String) && !MULT_STRINGS.key?(mult)
-        raise ArgumentError, "unknown key :#{mult}", caller
+        raise ArgumentError, "unknown key #{mult.inspect}", caller
       end
 
       case unit

data/lib/vector_number/version.rb

@@ -2,5 +2,5 @@
 
 class VectorNumber # rubocop:disable Style/StaticClass
   # @return [String]
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

data/lib/vector_number.rb

@@ -54,18 +54,15 @@ class VectorNumber
   # @param values [Array, Hash{Object => Integer, Float, Rational, BigDecimal}, VectorNumber]
   #   values for this number, hashes are treated like plain vector numbers
   # @param options [Hash{Symbol => Object}]
-  #   options for this number, if +values+ is a VectorNumber,
-  #   these will be merged with options from +values.options+
+  #   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
   #   text to use between unit and coefficient, see {Stringifying#to_s} for explanation
   # @yieldparam coefficient [Integer, Float, Rational, BigDecimal]
   # @yieldreturn [Integer, Float, Rational, BigDecimal] new coefficient
   # @raise [RangeError] if any pesky non-reals get where they shouldn't
-  def initialize(values = nil, options = {}.freeze, &)
-    # TODO: propagate options properly.
-    #   > (VectorNumber[1, 'a', mult: :invisible] + 2).options
-    #   => {:mult=>:dot}
-    super()
+  def initialize(values = nil, options = nil, &)
+    # @type var options: Hash[Symbol, Symbol]
     initialize_from(values)
     apply_transform(&)
     finalize_contents
@@ -78,9 +75,7 @@ class VectorNumber
   # Return self.
   #
   # @return [VectorNumber]
-  def dup
-    self
-  end
+  alias dup itself
 
   # Return self.
   #
@@ -106,7 +101,7 @@ class VectorNumber
   # @yieldreturn [Integer, Float, Rational, BigDecimal] new coefficient
   # @return [VectorNumber]
   def new(from = self, &)
-    self.class.new(from, &)
+    self.class.new(from, options, &)
   end
 
   # @param value [Object]
@@ -183,15 +178,26 @@ class VectorNumber
       case [options, values]
       in [{} | nil, VectorNumber]
         values.options
+      in [{} | nil, [*, VectorNumber => vector, *]]
+        vector.options
       in Hash, VectorNumber
-        values.options.merge(options).slice(*known_options)
+        merge_options(values.options, options)
+      in Hash, [*, VectorNumber => vector, *]
+        merge_options(vector.options, options)
       in Hash, _ unless options.empty?
-        default_options.merge(options).slice(*known_options)
+        merge_options(default_options, options)
       else
         default_options
       end
   end
 
+  def merge_options(base_options, added_options)
+    # 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)
+  end
+
   # Compact coefficients, calculate size and freeze data.
   # @return [void]
   def finalize_contents

data/sig/vector_number.rbs

@@ -1,3 +1,19 @@
+type vector_type = VectorNumber
+type real_number = Integer | Float | Rational | BigDecimal
+
+type in_value_type = untyped
+type unit_type = untyped
+type coefficient_type = real_number
+
+type list[T] = Array[T]
+
+type plain_vector_type = Hash[unit_type, coefficient_type]
+type units_list_type = list[unit_type]
+type coefficients_list_type = list[coefficient_type]
+type each_value_type = [unit_type, coefficient_type]
+
+type options_type = Hash[Symbol, untyped]
+
 interface _BaseMethods
   def size: -> Integer
   def options: -> options_type
@@ -35,7 +51,7 @@ class VectorNumber
   def self.[]: (*unit_type values, **options_type options) -> vector_type
 
   def initialize:
-    (?(units_list_type | plain_vector_type | vector_type)? values, ?options_type options)
+    (?(units_list_type | plain_vector_type | vector_type)? values, ?options_type? options)
     ?{ (coefficient_type coefficient) -> coefficient_type }
     -> void
 
@@ -74,16 +90,34 @@ class VectorNumber
     def +@: () -> self
 
     def -@: () -> vector_type
+    alias neg -@
 
     def +: (in_value_type) -> vector_type
+    alias add +
 
     def -: (in_value_type) -> vector_type
+    alias sub -
 
     def *: (real_number | vector_type) -> vector_type
+    alias mult *
 
     def /: (real_number | vector_type) -> vector_type
+    alias quo /
 
     def fdiv: (real_number | vector_type) -> vector_type
+
+    def div: (real_number | vector_type) -> vector_type
+
+    def %: (real_number | vector_type) -> vector_type
+    alias modulo %
+
+    def divmod: (real_number | vector_type) -> [vector_type, vector_type]
+
+    def remainder: (real_number | vector_type) -> vector_type
+
+    private
+
+    def check_divisibility: (real_number | vector_type) -> void
   end
 
   # Various mathematical operations that are also conversions.
@@ -100,6 +134,8 @@ class VectorNumber
     def ceil: (Integer) -> vector_type
 
     def floor: (Integer) -> vector_type
+
+    def round: (Integer, ?half: (:up | :down | :even)) -> vector_type
   end
 
   # Methods for converting to different number classes.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vector_number
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexandr Bulancov
 bindir: exe
 cert_chain: []
-date: 2025-02-25 00:00:00.000000000 Z
+date: 2025-05-12 00:00:00.000000000 Z
 dependencies: []
 executables: []
 extensions: []
@@ -27,7 +27,6 @@ files:
 - lib/vector_number/querying.rb
 - lib/vector_number/stringifying.rb
 - lib/vector_number/version.rb
-- sig/definitions.rbs
 - sig/vector_number.rbs
 homepage: https://github.com/trinistr/vector_number
 licenses:

data/sig/definitions.rbs

@@ -1,15 +0,0 @@
-type vector_type = VectorNumber
-type real_number = Integer | Float | Rational | BigDecimal
-
-type in_value_type = untyped
-type unit_type = untyped
-type coefficient_type = real_number
-
-type list[T] = Array[T]
-
-type plain_vector_type = Hash[unit_type, coefficient_type]
-type units_list_type = list[unit_type]
-type coefficients_list_type = list[coefficient_type]
-type each_value_type = [unit_type, coefficient_type]
-
-type options_type = Hash[Symbol, untyped]