vector_number 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8a4ba56677fa1eab6fc6dba7e8a7cc9d4afd769d9d0a4186ee51b2f400f2bab
-  data.tar.gz: 57f4d03d9495c2f6e98afb25008f659f63cf5cf0723664f1a3e7633568a8a179
+  metadata.gz: 60948b232b4ab095c808a54d3ba32748893db4c660a2ab553ad216d677906814
+  data.tar.gz: b3ff8e996c8617c7c6a5c0592f18480d78cd5f7c520ab47194ae965eb21406a5
 SHA512:
-  metadata.gz: 020ae7c79a25d4d18b6c2798d1c903e5f3a9699f8a2822ad7617ef3ada0ed4e2ef158a324548dfdc68de1a2bd70789487929d8d68def9b47133e077a4654d277
-  data.tar.gz: d34fb46be17a6cec0916257afcaccb842cdd24b7aa055377c1dbd343e6ffd90295df2a9725bf549709f6997276f88e1c1766f079c4848dc002b645180678e912
+  metadata.gz: d40eb5b5c6de69bd5db2579e9f6eb9f872abd67b68b49983c7d5c23d4a2726fbbaad128819631baf8e21e094d77986a4c69d53bcc408e2f838faffed9875c2bc
+  data.tar.gz: 4656e1b5a136191bede67f3c3203b3a43110e4c9700328b61d3802abfca3805ff39d7718d774a70eb0e0c20ea0a9e687fbdf6ce19594171148998b95ffcda9bd

data/CHANGELOG.md

@@ -6,6 +6,21 @@ 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.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.
+
+## [v0.2.5] — 2025-02-26
+
+Technical update after release to rubygems.org.
+README was updated to reflect this change.
+
 ## [v0.2.4] — 2025-02-26
 
 **Added**
@@ -17,7 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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.

data/README.md

@@ -16,12 +16,15 @@ Similar projects:
 
 ## Installation
 
-Add gem to your Gemfile:
-```ruby
-gem "vector_number", git: "https://github.com/trinistr/vector_number.git"
+Install with `gem`:
+```sh
+gem install vector_number
 ```
 
-Installation through `gem` is not currently supported.
+If using `bundler`, add gem to your Gemfile:
+```ruby
+gem "vector_number"
+```
 
 ## Usage
 
@@ -63,7 +66,7 @@ VectorNumber is developed on MRI (CRuby) but should work on other engines too.
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests, `rake rubocop` to check code, `rake steep` to check typing or just `rake` to do everything. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, change Next version in `CHANGELOG.md`, commit changes and tag the commit. Alternatively, an appropriate `rake bump:` command can be used.
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, change Next version in `CHANGELOG.md`, commit changes and tag the commit. Alternatively, an appropriate `rake bump:{major|minor|patch}` command can be used.
 
 ## Contributing
 

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

@@ -64,12 +64,13 @@ class VectorNumber
     end
 
     # 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 +79,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

@@ -48,7 +48,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.4"
+  VERSION = "0.2.6"
 end

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
@@ -82,8 +98,22 @@ class VectorNumber
     def *: (real_number | vector_type) -> vector_type
 
     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.

metadata

@@ -1,17 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vector_number
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Alexandr Bulancov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-25 00:00:00.000000000 Z
+date: 2025-04-30 00:00:00.000000000 Z
 dependencies: []
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -30,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:
@@ -40,7 +36,6 @@ metadata:
   source_code_uri: https://github.com/trinistr/vector_number
   changelog_uri: https://github.com/trinistr/vector_number/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -57,8 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: A library to add together anything.
 test_files: []

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]