vector_number 0.4.3 → 0.6.0

data/sig/vector_number.rbs

@@ -1,57 +1,37 @@
-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
+# A class to add together anything.
+class VectorNumber
+  # ---- Generic types ----
+  type real_number = Integer | Float | Rational | BigDecimal
 
-type list[T] = Array[T]
+  type in_value_type = untyped
+  type unit_type = untyped
+  type coefficient_type = real_number
 
-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 list[T] = Array[T]
 
-type options_type = Hash[Symbol, untyped]
+  type plain_instance = 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]
 
-interface _BaseMethods
-  def size: -> Integer
-  def options: -> options_type
+  # ---- Constants ----
 
-  # private
-  def new: () { (coefficient_type value) -> coefficient_type } -> vector_type
-         | (in_value_type) { (coefficient_type value) -> coefficient_type } -> vector_type
-         | () -> vector_type
-         | (in_value_type) -> vector_type
-  def real_number?: (real_number value) -> true
-                  | (vector_type) -> bool
-                  | (in_value_type value) -> false
-end
+  VERSION: String
 
-# A class to add together anything.
-class VectorNumber
-  include _BaseMethods
-  include VectorNumber::Mathing
-  include VectorNumber::MathConverting
-  include VectorNumber::Converting
-  include VectorNumber::Enumerating
-  include VectorNumber::Comparing
-  include VectorNumber::Querying
-  include VectorNumber::Stringifying
+  NUMERIC_UNITS: list[SpecialUnit]
+  R: SpecialUnit
+  I: SpecialUnit
 
-  VERSION: String
+  # ---- Public methods ----
 
-  KNOWN_OPTIONS: list[Symbol]
-  DEFAULT_OPTIONS: options_type
+  def self.[]: (*unit_type values) -> instance
 
-  UNIT: ^(Integer) -> Complex
-  R: Complex
-  I: Complex
+  def self.numeric_unit?: (unit_type unit) -> bool
 
-  def self.[]: (*unit_type values, **options_type options) -> vector_type
+  def size: -> Integer
 
   def initialize:
-    (?(units_list_type | plain_vector_type | vector_type)? values, ?options_type? options)
+    (?(units_list_type | plain_instance | instance)? values)
     ?{ (coefficient_type coefficient) -> coefficient_type }
     -> void
 
@@ -63,197 +43,179 @@ class VectorNumber
   private
 
   @size: Integer
-  @options: options_type
-  @data: plain_vector_type
+  @data: plain_instance
+
+  def new: () { (coefficient_type value) -> coefficient_type } -> instance
+         | (in_value_type) { (coefficient_type value) -> coefficient_type } -> instance
+         | () -> instance
+         | (in_value_type) -> instance
+
+  def real_number?: (real_number value) -> true
+                  | (instance) -> bool
+                  | (in_value_type value) -> false
 
-  def initialize_from: ((units_list_type | plain_vector_type | vector_type)? values) -> void
+  def initialize_from: ((units_list_type | plain_instance | instance)? values) -> void
 
-  def add_value_to_data: ((vector_type | Numeric | unit_type) value) -> void
+  def add_value_to_data: ((instance | Numeric | unit_type) value) -> void
 
   def add_numeric_value_to_data: (Numeric value) -> void
 
-  def add_vector_to_data: ((vector_type | plain_vector_type) vector) -> void
+  def add_vector_to_data: ((instance | plain_instance) vector) -> void
 
   def apply_transform: () ?{ (coefficient_type value) -> coefficient_type } -> void
 
-  def save_options: (options_type? options, values: in_value_type) -> void
-  def merge_options: (options_type base_options, options_type added_options) -> options_type
-  def default_options: () -> options_type
-  def known_options: () -> list[Symbol]
-
   def finalize_contents: () -> void
+end
 
-  # Methods for performing actual math.
-  module Mathing
-    include _BaseMethods
-
-    def coerce: (in_value_type) -> [vector_type, 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 *
+# Methods for performing actual math.
+class VectorNumber
+  def coerce: (in_value_type) -> [instance, self]
 
-    def /: (real_number | vector_type) -> vector_type
-    alias quo /
+  def -@: () -> instance
+  alias neg -@
 
-    def fdiv: (real_number | vector_type) -> vector_type
+  def +: (in_value_type) -> instance
+  alias add +
 
-    def div: (real_number | vector_type) -> vector_type
+  def -: (in_value_type) -> instance
+  alias sub -
 
-    def %: (real_number | vector_type) -> vector_type
-    alias modulo %
+  def *: (real_number | instance) -> instance
+  alias mult *
 
-    def divmod: (real_number | vector_type) -> [vector_type, vector_type]
+  def /: (real_number | instance) -> instance
+  alias quo /
 
-    def remainder: (real_number | vector_type) -> vector_type
+  def fdiv: (real_number | instance) -> instance
 
-    private
+  def div: (real_number | instance) -> instance
 
-    def check_divisibility: (real_number | vector_type) -> void
-  end
+  def %: (real_number | instance) -> instance
+  alias modulo %
 
-  # Various mathematical operations that are also conversions.
-  module MathConverting
-    include _BaseMethods
-    include Enumerating
+  def divmod: (real_number | instance) -> [instance, instance]
 
-    def abs: () -> Float
+  def remainder: (real_number | instance) -> instance
 
-    def abs2: () -> Float
-
-    def truncate: (Integer) -> vector_type
+  private
 
-    def ceil: (Integer) -> vector_type
+  def check_divisibility: (real_number | instance) -> void
+end
 
-    def floor: (Integer) -> vector_type
+# Various mathematical operations that are also conversions.
+class VectorNumber
+  def abs: () -> Float
 
-    def round: (Integer, ?half: (:up | :down | :even)) -> vector_type
-  end
+  def abs2: () -> Float
 
-  # Methods for converting to different number classes.
-  module Converting
-    include _BaseMethods
-    include Querying
+  def truncate: (?Integer) -> instance
 
-    def real: () -> real_number
+  def ceil: (?Integer) -> instance
 
-    def imaginary: () -> real_number
-    alias imag imaginary
+  def floor: (?Integer) -> instance
 
-    def to_i: () -> Integer
-            | () -> void
-    alias to_int to_i
+  def round: (?Integer, ?half: (:up | :down | :even)) -> instance
+end
 
-    def to_f: () -> Float
-            | () -> void
+# Methods for converting to different number classes.
+class VectorNumber
+  def real: () -> real_number
 
-    def to_r: () -> Rational
-            | () -> void
+  def imaginary: () -> real_number
+  alias imag imaginary
 
-    def to_d: (?Integer?) -> BigDecimal
-            | (?Integer?) -> void
+  def to_i: () -> Integer
+  alias to_int to_i
 
-    def to_c: () -> Complex
-            | () -> void
+  def to_f: () -> Float
 
-    def truncate: (?Integer digits) -> vector_type
+  def to_r: () -> Rational
 
-    private
+  def to_d: (?Integer?) -> BigDecimal
 
-    def raise_convert_error: (Class) -> void
-  end
+  def to_c: () -> Complex
 
-  # Methods for enumerating values of the number.
-  module Enumerating
-    include _BaseMethods
-    include _Each[each_value_type]
-    include Enumerable[each_value_type]
+  private
 
-    def each: () { (unit_type unit, coefficient_type coefficient) -> void } -> self
-            | () -> Enumerator[each_value_type, Integer]
-            | ...
-    alias each_pair each
+  def raise_convert_error: (Class) -> void
+end
 
-    def units: () -> units_list_type
-    alias keys units
+class VectorNumber
+  include _Each[each_value_type]
+  include Enumerable[each_value_type]
 
-    def coefficients: () -> coefficients_list_type
-    alias values coefficients
+  def each: () { (unit_type unit, coefficient_type coefficient) -> void } -> self
+          | () -> Enumerator[each_value_type, Integer]
+          | ...
+  alias each_pair each
 
-    def to_h: () -> plain_vector_type
-            | () { (unit_type, coefficient_type) -> each_value_type } -> plain_vector_type
+  def units: () -> units_list_type
+  alias keys units
 
-    def []: (unit_type unit) -> coefficient_type
+  def coefficients: () -> coefficients_list_type
+  alias values coefficients
 
-    def unit?: (unit_type unit) -> bool
-    alias key? unit?
-  end
+  def to_h: () -> plain_instance
+          | () { (unit_type, coefficient_type) -> each_value_type } -> plain_instance
 
-  # Methods for comparing with other numbers.
-  module Comparing
-    include _BaseMethods
-    include Enumerating
-    include Converting
-    include Querying
+  def []: (unit_type unit) -> coefficient_type
 
-    def ==: (in_value_type other) -> bool
+  def unit?: (unit_type unit) -> bool
+  alias key? unit?
+end
 
-    def eql?: (in_value_type other) -> bool
+# Methods for comparing with other numbers.
+class VectorNumber
+  def ==: (in_value_type other) -> bool
 
-    def hash: () -> Integer
+  def eql?: (in_value_type other) -> bool
 
-    def <=>: (in_value_type other) -> Integer?
-  end
+  def hash: () -> Integer
 
-  # Methods for querying state of the number.
-  # Mostly modeled after {::Complex}.
-  module Querying
-    include Enumerating
+  def <=>: (in_value_type other) -> Integer?
+end
 
-    def numeric?: (?Integer) -> bool
+# Methods for querying state of the number.
+# Mostly modeled after {::Complex}.
+class VectorNumber
+  def numeric?: (?Integer) -> bool
 
-    def nonnumeric?: (?Integer) -> bool
+  def nonnumeric?: (?Integer) -> bool
 
-    def finite?: () -> bool
+  def finite?: () -> bool
 
-    def infinite?: () -> Integer?
+  def infinite?: () -> Integer?
 
-    def zero?: () -> bool
+  def zero?: () -> bool
 
-    def nonzero?: () -> self?
+  def nonzero?: () -> self?
 
-    def positive?: () -> bool
+  def positive?: () -> bool
 
-    def negative?: () -> bool
+  def negative?: () -> bool
 
-    def real?: () -> false
+  def real?: () -> false
 
-    def integer?: () -> false
-  end
+  def integer?: () -> false
+end
 
-  # Methods and options for string representation.
-  module Stringifying
-    include Querying
+# Methods and options for string representation.
+class VectorNumber
+  MULT_STRINGS: Hash[Symbol, String]
 
-    MULT_STRINGS: Hash[Symbol, String]
+  def to_s: (?mult: (Symbol | String)) { (unit_type, coefficient_type, ?Integer index, ?String operator) -> String } -> String
 
-    def to_s: (?mult: (Symbol | String)) -> String
+  def inspect: () -> String
 
-    def inspect: () -> String
+  private
 
-    private
+  def build_string: (String operator) -> String
+                  | (String operator) { (unit_type, coefficient_type, ?Integer index, ?String operator) -> String } -> String
 
-    def value_to_s: (unit_type unit, coefficient_type coefficient, mult: (Symbol | String)) -> String
-  end
+  def value_to_s: (unit_type unit, coefficient_type coefficient, String operator) -> String
+end
 
+class VectorNumber
   # Refinements of Numeric classes to better work with VectorNumber and similar classes.
   module NumericRefinements
     module CommutativeShuttle
@@ -266,3 +228,14 @@ class VectorNumber
     end
   end
 end
+
+class VectorNumber
+  # Class for representing special numerical units.
+  class SpecialUnit
+    def initialize: (Object unit, String text) -> void
+
+    def to_s: () -> String
+    
+    def inspect: () -> String
+  end
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: vector_number
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
-- Alexandr Bulancov
+- Alexander Bulancov
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -13,18 +13,20 @@ description: |
   VectorNumber provides a Numeric-like experience for doing arithmetics on heterogeneous objects, with more advanced operations based on real vector spaces available when needed.
 
   Features:
-  - Add and subtract (almost) any object, with no setup or declaration.
-  - Multiply and divide vectors by any real number to create 1.35 of an array and -2 of a string. What does that mean? Only you know!
-  - Use vectors instead of inbuilt numbers in most situtations with no difference in behavior. Or, use familiar methods from numerics with sane semantics!
-  - Enumerate vectors in a hash-like fashion, or transform to an array or hash as needed.
-  - Enjoy a mix of vector-, complex- and polynomial-like behavior at appropriate times.
-  - No dependencies, no extensions. It just works!
+  * Add and subtract (almost) any object, with no setup or declaration.
+  * Multiply and divide vectors by any real number to create 1.35 of an array and -2 of a string. What does that mean? Only you know!
+  * Use vectors instead of inbuilt numbers in most situtations with no difference in behavior. Or, use familiar methods from numerics with sane semantics!
+  * Enumerate vectors in a hash-like fashion, or transform to an array or hash as needed.
+  * Enjoy a mix of vector-, complex- and polynomial-like behavior at appropriate times.
+  * No dependencies, no extensions. It just works!
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- doc/vector_space.svg
 files:
 - README.md
+- doc/vector_space.svg
 - lib/vector_number.rb
 - lib/vector_number/comparing.rb
 - lib/vector_number/converting.rb
@@ -33,6 +35,7 @@ files:
 - lib/vector_number/mathing.rb
 - lib/vector_number/numeric_refinements.rb
 - lib/vector_number/querying.rb
+- lib/vector_number/special_unit.rb
 - lib/vector_number/stringifying.rb
 - lib/vector_number/version.rb
 - sig/vector_number.rbs
@@ -42,9 +45,9 @@ 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.4.3
-  source_code_uri: https://github.com/trinistr/vector_number/tree/v0.4.3
-  changelog_uri: https://github.com/trinistr/vector_number/blob/v0.4.3/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/vector_number/0.6.0
+  source_code_uri: https://github.com/trinistr/vector_number/tree/v0.6.0
+  changelog_uri: https://github.com/trinistr/vector_number/blob/v0.6.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options:
 - "--main"