math_symbols 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edc8e9a4edbcb1fc0d04a97a63ed2d5f533d09b62b3c7c36f76359d06bea4908
+  data.tar.gz: 75bb6cffe3695d599df6700c9666b82d41e37dab6fefe7176e29753e2c7e305b
+SHA512:
+  metadata.gz: 94026b5b073870d8298f932b69e60fc6f21e10e461aceeabc0586aaedbe7352dad6dc343ccafd9c85d1ab10e74fe0d25f610a61dee9b0232b4ce1d6b87b43795
+  data.tar.gz: 31f4e73151d8a392919aaa0a4022c6571243f2089afedab3c87741894025869fbc5430ffd6d84969f09e9cf8abb8c60a4b26c8abbafd30449f96ef62920571a9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,49 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/AsciiIdentifiers:
+  Enabled: false
+
+Style/Alias:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/SpaceInsideParens:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Style/RedundantParentheses:
+  Enabled: false
+
+Style/EmptyLiteral:
+  Enabled: false
+
+Lint/AmbiguousOperator:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-01-26
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Dalton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# MathSymbols
+
+Support for mathematical syntactic sugars!
+
+## Installation
+
+```sh
+gem install math_symbols
+```
+
+## Usage
+
+This is how we should write function that calculates a fourier for a step
+function without this gem:
+
+```ruby
+def traditional_way(x, n_max = 10)
+  (4/Math::PI) * (1..n_max).step(2).inject(0) do |acc, n|
+    acc += Math.sin(n*Math::PI*x)/n
+  end
+end
+
+traditional_way(0.5) # => 1.0630539690963425
+```
+
+This is how we can do with it:
+
+```ruby
+require 'math_symbols'
+using MathSymbols
+
+sweet_way = ƒ do |x, n_max = 10|
+  (4/π) * (1..n_max).step(2).∑{ |n| sin(n*π*x)/n }
+end
+
+sweet_way[0.5] # => 1.0630539690963425
+```
+
+or
+
+```ruby
+require 'math_symbols'
+using MathSymbols
+
+def sweet_way(x, n_max = 10)
+  λ do
+    (4/π) * (1..n_max).step(2).∑{ |n| sin(n*π*x)/n }
+  end
+end
+
+sweet_way(0.5) # => 1.0630539690963425
+```
+
+Which one is easier to read and therefor maintain?
+
+## Usage Without Refinements
+
+If you prefer not to use refinements, just load its core extensions in the same
+way that you would have done on ActiveSupport.
+
+```ruby
+require 'math_symbols/core_ext'
+
+π # => 3.141592
+```
+
+## Development
+
+Run `rake` to rubocop, RBS and RSpec tests.
+
+## Contributing
+
+Bug reports and PRs are welcome on GitHub at
+https://github.com/dalthon/math_symbols.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+RuboCop::RakeTask.new
+
+task default: %i[rubocop steep spec]
+
+task :steep do
+  require 'steep'
+  require 'steep/cli'
+
+  Steep::CLI.new(argv: ['check'], stdout: $stdout, stderr: $stderr, stdin: $stdin).run
+end
+
+namespace :steep do
+  task :stats do
+    exec %q(bundle exec steep stats --log-level=fatal | awk -F',' '{ printf "%-28s %-9s %-12s %-14s %-10s\n", $2, $3, $4, $5, $7 }') # rubocop:disable Layout/LineLength
+  end
+end

data/Steepfile

@@ -0,0 +1,11 @@
+target :lib do
+  signature 'sig'
+
+  check 'lib/math_symbols'
+end
+
+# target :spec do
+#   signature 'sig'
+#
+#   check 'spec'
+# end

data/lib/math_symbols/core_ext/array.rb

@@ -0,0 +1,6 @@
+class << Array
+  def ø
+    []
+  end
+  alias :Ø :ø
+end

data/lib/math_symbols/core_ext/boolean.rb

@@ -0,0 +1,29 @@
+class TrueClass
+  def ⊕(other)
+    !other
+  end
+
+  def ⇔(other)
+    other
+  end
+  alias :↔ :⇔
+
+  def ⇒(other)
+    other
+  end
+end
+
+class FalseClass
+  def ⊕(other)
+    other
+  end
+
+  def ⇔(other)
+    !other
+  end
+  alias :↔ :⇔
+
+  def ⇒(_other)
+    true
+  end
+end

data/lib/math_symbols/core_ext/complex.rb

@@ -0,0 +1,5 @@
+class Complex
+  def √(value)
+    value ** (1.0 / self)
+  end
+end

data/lib/math_symbols/core_ext/enumerable.rb

@@ -0,0 +1,17 @@
+module Enumerable
+  def ∑
+    inject 0 do |acc, x|
+      yield(x) + acc
+    end
+  end
+
+  def ∏
+    inject 1 do |acc, x|
+      yield(x) * acc
+    end
+  end
+
+  alias :∀ :all?
+  alias :∃ :any?
+  alias :∄ :none?
+end

data/lib/math_symbols/core_ext/float.rb

@@ -0,0 +1,5 @@
+class Float
+  def √(value)
+    value ** (1.0 / self)
+  end
+end

data/lib/math_symbols/core_ext/hash.rb

@@ -0,0 +1,6 @@
+class << Hash
+  def ø
+    {}
+  end
+  alias :Ø :ø
+end

data/lib/math_symbols/core_ext/integer.rb

@@ -0,0 +1,23 @@
+class Integer
+  def √(value)
+    value ** (1.0 / self)
+  end
+
+  def ⊕(value)
+    self ^ value
+  end
+
+  def ⇔(value)
+    max_bit_length = value.bit_length
+    max_bit_length = bit_length if bit_length > max_bit_length
+    mask = (1 << max_bit_length) - 1
+
+    (self & value) | ((mask ^ self) & (mask ^ value))
+  end
+  alias :↔ :⇔
+
+  def ⇒(value)
+    mask = (1 << bit_length) - 1
+    (mask ^ self) | value
+  end
+end

data/lib/math_symbols/core_ext/math.rb

@@ -0,0 +1,3 @@
+module Math
+  extend MathSymbols::MathExtensions
+end

data/lib/math_symbols/core_ext/object.rb

@@ -0,0 +1,21 @@
+class Object
+  include MathSymbols::MathExtensions
+
+  def ∈(set)
+    set.include? self
+  end
+
+  def ∉(set)
+    !∈(set)
+  end
+
+  def ƒ(&block)
+    lambda do |*x|
+      Math.instance_exec(*x, &block)
+    end
+  end
+
+  def λ(&block)
+    Math.instance_eval(&block)
+  end
+end

data/lib/math_symbols/core_ext/rational.rb

@@ -0,0 +1,5 @@
+class Rational
+  def √(value)
+    value ** (1.0 / self)
+  end
+end

data/lib/math_symbols/core_ext.rb

@@ -0,0 +1,12 @@
+require_relative 'math_extensions'
+
+require_relative 'core_ext/array'
+require_relative 'core_ext/boolean'
+require_relative 'core_ext/complex'
+require_relative 'core_ext/enumerable'
+require_relative 'core_ext/float'
+require_relative 'core_ext/hash'
+require_relative 'core_ext/integer'
+require_relative 'core_ext/math'
+require_relative 'core_ext/object'
+require_relative 'core_ext/rational'

data/lib/math_symbols/math_extensions.rb

@@ -0,0 +1,35 @@
+module MathSymbols
+  module MathExtensions
+    def ∑(enumerable)
+      enumerable.inject 0 do |acc, x|
+        acc + yield(x)
+      end
+    end
+
+    def ∏(enumerable)
+      enumerable.inject 1 do |acc, x|
+        acc * yield(x)
+      end
+    end
+
+    def √(value)
+      Math.sqrt value
+    end
+
+    def Γ(value)
+      Math.gamma value
+    end
+
+    def π
+      Math::PI
+    end
+
+    def ∞
+      Float::INFINITY
+    end
+
+    def δ(value)
+      value.zero? ? ∞ : 0
+    end
+  end
+end

data/lib/math_symbols/version.rb

@@ -0,0 +1,3 @@
+module MathSymbols
+  VERSION = '0.1.0'.freeze
+end

data/lib/math_symbols.rb

@@ -0,0 +1,133 @@
+require_relative 'math_symbols/version'
+require_relative 'math_symbols/math_extensions'
+
+module MathSymbols # rubocop:disable Metrics/ModuleLength
+  refine Math.singleton_class do
+    import_methods MathSymbols::MathExtensions
+  end
+
+  refine Array.singleton_class do
+    def ø
+      []
+    end
+    alias :Ø :ø
+  end
+
+  refine Hash.singleton_class do
+    def ø
+      {}
+    end
+    alias :Ø :ø
+  end
+
+  refine Enumerable do
+    def ∑
+      inject 0 do |acc, x|
+        yield(x) + acc
+      end
+    end
+
+    def ∏
+      inject 1 do |acc, x|
+        yield(x) * acc
+      end
+    end
+
+    alias :∀ :all?
+    alias :∃ :any?
+    alias :∄ :none?
+  end
+
+  refine Object do
+    import_methods MathSymbols::MathExtensions
+
+    def δ(value)
+      value.zero? ? ∞ : 0
+    end
+
+    def ∈(set)
+      set.include? self
+    end
+
+    def ∉(set)
+      !∈(set)
+    end
+
+    def ƒ(&block)
+      lambda do |*x|
+        Math.instance_exec(*x, &block)
+      end
+    end
+
+    def λ(&block)
+      Math.instance_eval(&block)
+    end
+  end
+
+  refine TrueClass do
+    def ⊕(other)
+      !other
+    end
+
+    def ⇔(other)
+      other
+    end
+    alias :↔ :⇔
+
+    def ⇒(other)
+      other
+    end
+  end
+
+  refine FalseClass do
+    def ⊕(other)
+      other
+    end
+
+    def ⇔(other)
+      !other
+    end
+    alias :↔ :⇔
+
+    def ⇒(_other)
+      true
+    end
+  end
+
+  refine Integer do
+    def √(value)
+      value ** (1.0 / self)
+    end
+
+    def ⊕(value)
+      self ^ value
+    end
+
+    def ⇔(value)
+      (self && value) || (!self && !value)
+    end
+    alias :↔ :⇔
+
+    def ⇒(value)
+      !self || value
+    end
+  end
+
+  refine Float do
+    def √(value)
+      value ** (1.0 / self)
+    end
+  end
+
+  refine Complex do
+    def √(value)
+      value ** (1.0 / self)
+    end
+  end
+
+  refine Rational do
+    def √(value)
+      value ** (1.0 / self)
+    end
+  end
+end

data/sig/math_symbols/core_ext/array.rbs

@@ -0,0 +1,4 @@
+class Array[unchecked out T]
+  def self.`ø`: [T] () -> Array[T]
+  def self.`Ø`: [T] () -> Array[T]
+end

data/sig/math_symbols/core_ext/boolean.rbs

@@ -0,0 +1,13 @@
+class TrueClass
+  def `⊕`: (bool) -> bool
+  def `⇔`: (bool) -> bool
+  def `↔`: (bool) -> bool
+  def `⇒`: (bool) -> bool
+end
+
+class FalseClass
+  def `⊕`: (bool) -> bool
+  def `⇔`: (bool) -> bool
+  def `↔`: (bool) -> bool
+  def `⇒`: (bool) -> bool
+end

data/sig/math_symbols/core_ext/complex.rbs

@@ -0,0 +1,3 @@
+class Complex
+  def `√`: (Integer | Float | Complex | Rational value) -> Numeric
+end

data/sig/math_symbols/core_ext/enumerable.rbs

@@ -0,0 +1,8 @@
+module Enumerable[unchecked out Elem] : _Each[Elem]
+  def `∑`: [Elem] () { (Elem) -> (Numeric & _Summable)     } -> (Numeric & _Summable)
+  def `∏`: [Elem] () { (Elem) -> (Numeric & _Multipliable) } -> (Numeric & _Multipliable)
+
+  def `∀`: [Elem] () { (Elem) -> boolish } -> bool
+  def `∃`: [Elem] () { (Elem) -> boolish } -> bool
+  def `∄`: [Elem] () { (Elem) -> boolish } -> bool
+end

data/sig/math_symbols/core_ext/float.rbs

@@ -0,0 +1,3 @@
+class Float
+  def `√`: (Integer | Float | Complex | Rational value) -> Numeric
+end

data/sig/math_symbols/core_ext/hash.rbs

@@ -0,0 +1,4 @@
+class Hash[unchecked out K, unchecked out V]
+  def self.`ø`: [K, V] () -> Hash[K, V]
+  def self.`Ø`: [K, V] () -> Hash[K, V]
+end

data/sig/math_symbols/core_ext/integer.rbs

@@ -0,0 +1,8 @@
+class Integer
+  def `√`: (Integer | Float | Complex | Rational value) -> Numeric
+
+  def `⊕`: (Integer value) -> Integer
+  def `⇔`: (Integer value) -> Integer
+  def `↔`: (Integer value) -> Integer
+  def `⇒`: (Integer value) -> Integer
+end

data/sig/math_symbols/core_ext/object.rbs

@@ -0,0 +1,7 @@
+class Object
+  def `∈`: (untyped set) -> bool
+  def `∉`: (untyped set) -> bool
+
+  def `ƒ`: [V, U] () { (*V) [self: singleton(Math)] -> U } -> (^(*V) [self: singleton(Math)] -> U)
+  def `λ`: [U] () { (singleton(Math)) [self: singleton(Math)] -> U } -> U
+end

data/sig/math_symbols/core_ext/rational.rbs

@@ -0,0 +1,3 @@
+class Rational
+  def `√`: (Integer | Float | Complex | Rational value) -> Numeric
+end

data/sig/math_symbols/math_extensions.rbs

@@ -0,0 +1,22 @@
+interface _Summable
+  def +: (Integer | Float | Complex | Rational) -> (Integer | Float | Complex | Rational)
+end
+
+interface _Multipliable
+  def *: (Integer | Float | Complex | Rational) -> (Integer | Float | Complex | Rational)
+end
+
+module MathSymbols
+  module MathExtensions
+    def `∑`: [Elem] (Enumerable[Elem] enumerable) { (Elem) -> (Numeric & _Summable)     } -> (Numeric & _Summable)
+    def `∏`: [Elem] (Enumerable[Elem] enumerable) { (Elem) -> (Numeric & _Multipliable) } -> (Numeric & _Multipliable)
+
+    def `√`: (Numeric & _ToF value) -> (Numeric & _ToF)
+    def `Γ`: (Numeric & _ToF value) -> (Numeric & _ToF)
+
+    def `π`: () -> Float
+    def `∞`: () -> Numeric
+
+    def `δ`: (untyped value) -> Numeric
+  end
+end

data/sig/math_symbols.rbs

@@ -0,0 +1,3 @@
+module MathSymbols
+  VERSION: String
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: math_symbols
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dalton Pinto
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-29 00:00:00.000000000 Z
+dependencies: []
+description: Support for mathematical syntactic sugars
+email:
+- dalton.pinto@local
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/math_symbols.rb
+- lib/math_symbols/core_ext.rb
+- lib/math_symbols/core_ext/array.rb
+- lib/math_symbols/core_ext/boolean.rb
+- lib/math_symbols/core_ext/complex.rb
+- lib/math_symbols/core_ext/enumerable.rb
+- lib/math_symbols/core_ext/float.rb
+- lib/math_symbols/core_ext/hash.rb
+- lib/math_symbols/core_ext/integer.rb
+- lib/math_symbols/core_ext/math.rb
+- lib/math_symbols/core_ext/object.rb
+- lib/math_symbols/core_ext/rational.rb
+- lib/math_symbols/math_extensions.rb
+- lib/math_symbols/version.rb
+- sig/math_symbols.rbs
+- sig/math_symbols/core_ext/array.rbs
+- sig/math_symbols/core_ext/boolean.rbs
+- sig/math_symbols/core_ext/complex.rbs
+- sig/math_symbols/core_ext/enumerable.rbs
+- sig/math_symbols/core_ext/float.rbs
+- sig/math_symbols/core_ext/hash.rbs
+- sig/math_symbols/core_ext/integer.rbs
+- sig/math_symbols/core_ext/object.rbs
+- sig/math_symbols/core_ext/rational.rbs
+- sig/math_symbols/math_extensions.rbs
+homepage: https://github.com/dalthon/math_symbols
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dalthon/math_symbols
+  source_code_uri: https://github.com/dalthon/math_symbols
+  changelog_uri: https://github.com/dalthon/math_symbols/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.5
+signing_key:
+specification_version: 4
+summary: Support for mathematical syntactic sugars
+test_files: []