ChebyRuby 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3252d81142e31e2eb4e1f6f9375505e82ab92351
-  data.tar.gz: c24e5191aff126747b837a13e5a8fc9bb0dbf79e
+  metadata.gz: bcc33ce7c3a803a3612eca3dbb20a83a520a32fe
+  data.tar.gz: 593ee57abfe76a5b961919632da5ea9b449d5a9b
 SHA512:
-  metadata.gz: 5919c55140a5632c3defee1f22c1459ef524d6351e4f54b1aa8598bf2ba5fbb7262bb1f7cf1febe3a0db1168bbfda9b59e482d7412e410cd4b35972910ed7791
-  data.tar.gz: e57d75af7a75e6421707b8cd6226368c12fb6cabc642fff624b831738712ed7f44ab653c90fe877c2b74b2f275224429240258bba6c85ec24fa2d452003e2b92
+  metadata.gz: 7b4d24ae70a0cd5cd1073b1cecc2d0ea59a450bbec62dc89461b24086c794f8920efe6236e7e7a5b77a86400ab890d6086f78054ab79b784dfd353b797fe1ff0
+  data.tar.gz: 0f0c4781e443cb21bf210262e349111f70d35a992c7e07008f0d07338a0f710da658ac6e91403e415b7d11c16f3b938082512c7c95e115e355d688c077059f39

data/README.md

@@ -0,0 +1,27 @@
+# ChebyRuby
+[![Gem Version](https://badge.fury.io/rb/ChebyRuby.svg)](https://badge.fury.io/rb/ChebyRuby)
+
+## Name
+The name is an homage to one of my favorite mathematicians: [Pafnuty Lvovich
+Chebyshev](https://en.wikipedia.org/wiki/Pafnuty_Chebyshev). The Chebyshev polynomial is such an
+important concept in mathematics and I am eternally grateful for his discovery of that.
+Additionally, shortening his name to the nickname _Cheby_ works really well with Ruby.
+
+## Description
+This is a gem that is designed to aid with numerical analysis and scientific computing in Ruby. As
+of now it has relatively rudimentary numeric integration and differentiation methods heavily
+inspired by the Apache Commons[Math] project. The end goal is for this to be a substantive numerical
+analysis suite for Ruby.
+
+## Contributing
+Contributors are more than welcome. The style rules I abide by are:
+- 2 spaces for indentation
+- 80 character max column size
+- Single quote unless a double quote is necessary
+- Yard style commenting
+- Use `Class::X` to refer to a constant and `Class.x` to refer to a class 
+method.
+
+## License
+
+This work is under the MIT License. (Eli Sadoff 2016)

data/lib/chebyruby.rb

@@ -1,8 +1,8 @@
-class ChebyRuby
-  
-end
-
 require 'chebyruby/romberg_integration'
 require 'chebyruby/simpsons_integration'
 require 'chebyruby/integration'
 require 'chebyruby/univariate_function'
+
+# This is an empty module for the project.
+module Chebyruby
+end

data/lib/chebyruby/expression.rb

@@ -1,18 +1,48 @@
-# require_relative 'univariate_function'
+require_relative 'univariate_function'
 
+# This is a class for generic expressions.
+# Whereas univariate functions are analogous to named functions
+# this is more similar to a lambda. Additionally, this is more
+# in the field of CAS instead of numerical analysis. Note:
+# This is not at all stable or well tested and exists to try out
+# but do not at all rely on this class.
+#
+# @attr left [Object] the left side of the expression (on a binary operator)
+# @attr op [Operator] the binary operator
+# @attr right [Object] the right side of the expression
 class Expression
   attr_accessor :left, :op, :right
 
+  # The constructor for the class Expression
+  #
+  # @param [Object] left the left side of the expression
+  # @param [Operator] op the binary operator
+  # @param [Object] right the right side of the expression
   def initialize(left, op, right)
     @left = left
     @op = op
     @right = right
   end
 
+  # The method missing method for expressions. Using some
+  # swanky tricks, a non-extant method on an expression is turned
+  # into a binary operator using a symbol and creates a new expression
+  # with the left expression being nested into a unit. Thus the expressions
+  # are by default left associative.
+  #
+  # @param [Object] method the method that is missing
+  # @param [Object[]] args the args that are passed to the missing method
+  # @return a new expression
   def method_missing(method, *args)
     Expression.new(self, method, Variable.new(args[0]))
   end
 
+  # This method returns a flattened list of the variables within an
+  # expression. For example, the expression
+  # <code>((x + y) + z) + a</code>
+  # will have a vars of [x, y, z, a]
+  #
+  # @return an array of the variables
   def vars
     a = []
     nested?[:left] ? a << left.vars : a << left.x
@@ -20,11 +50,18 @@ class Expression
     (a.flatten rescue a).select{|i| String === i}.uniq
   end
 
+  # This method returns a hash describing if the right
+  # and/or left sides of an expression are nested.
+  #
+  # @return a boolean hash with keys [:right, :left]
   def nested?
     {:right => (Expression === right),
      :left => (Expression === left)}
   end
 
+  # This method returns a string version of an expression.
+  #
+  # @return a string version of an expression
   def to_s
     if nested?[:left]
       s = "#{left.to_s} #{op}"
@@ -38,6 +75,9 @@ class Expression
     end
   end
 
+  # This turns the anonymous expression into a function
+  #
+  # @return a function of the expression.
   def to_func
     if a.vars.size == 1
       blk = ->(intvar) {eval(to_s.gsub(vars[0],'intvar'))}

data/lib/chebyruby/finite_differencing.rb

@@ -27,7 +27,7 @@ class ChebyRuby::FiniteDifferencing
 
   # This does forward finite differencing. 
   # The formula being used is:
-  # <pre> Sum[(-1)^i * Binom(n i) * f(x + (n-i) * h), {i, 0, n}]/(h^n) </pre>
+  # <pre> Sum[(-1)^i * Binom(n i) * f(x + (n-i) * h), (i, 0, n)]/(h^n) </pre>
   # 
   # @param [Numeric] x the value at which to find the derivative
   # @param [Numeric] h the value to use for the differencing (generally 
@@ -44,7 +44,7 @@ class ChebyRuby::FiniteDifferencing
 
   # This does backward finite differencing. 
   # The formula being used is:
-  # <pre> Sum[(-1)^i * Binom(n i) * f(x - i*h), {i, 0, n}]/(h^n) </pre>
+  # <pre> Sum[(-1)^i * Binom(n i) * f(x - i*h), (i, 0, n)]/(h^n) </pre>
   # 
   # @param [Numeric] x the value at which to find the derivative
   # @param [Numeric] h the value to use for the differencing (generally 
@@ -61,7 +61,7 @@ class ChebyRuby::FiniteDifferencing
 
   # This does central finite differencing. 
   # The formula being used is:
-  # <pre> Sum[(-1)^i * Binom(n i) * f(x + (n/2-i) * h), {i, 0, n}]/(h^n) </pre>
+  # <pre> Sum[(-1)^i * Binom(n i) * f(x + (n/2-i) * h), (i, 0, n)]/(h^n) </pre>
   # 
   # @param [Numeric] x the value at which to find the derivative
   # @param [Numeric] h the value to use for the differencing (generally 
@@ -87,4 +87,4 @@ class ChebyRuby::FiniteDifferencing
       (n + 1 - i)/i.to_f
     end.inject(:*) || 1
   end
-end
+end

data/lib/chebyruby/variable.rb

@@ -1,17 +1,35 @@
 require_relative 'expression'
 
+# This is the class for a variable in an expression. It is part of the 
+# CAS side-project in ChebyRuby.
+#
+# @attr x [String] the variable name
+# @attr neg [Boolean] the negation status of the variable
 class Variable
   attr_accessor :x, :neg
 
-  def initialize(x)
+  # This is the constructor for the variable class
+  #
+  # @param [String] x the variable name to initialize
+  # @param [Boolean] neg the negation status of the variable
+  def initialize(x, neg = false)
     @x = x
     @neg = false
   end
 
+  # This variadic method missing works with Expression's method missing
+  # to construct and expression from variables.
+  #
+  # @param [Object] method the method that is missing
+  # @param [Object[]] args the args that are passed to the missing method
+  # @return a new expression
   def method_missing(method, *args)
     Expression.new(self, method, Variable.new(args[0]))
   end
 
+  # This method will turn a variadic variable into an array
+  #
+  # @return an array of the variable
   def to_a
     if x.class == Array
       x
@@ -20,22 +38,39 @@ class Variable
     end
   end
 
+  # This is an overriding of the unary negation operation that allows for
+  # negation of a variable as simply as -x.
+  #
+  # @return a negated form of the current variable
   def -@
-    @neg = true
+    Variable.new(@x, !@neg)
   end
 
+  # This turns the current array variable into an enumerator
+  #
+  # @return an enumerated form of the array variable
   def to_enum
     Array.new(to_ary).to_enum
   end
 
+  # A nil returning function for the purposes of expression building
+  #
+  # @return nil
   def right
     nil
   end
 
+  # A basic to_s function
+  #
+  # @return a string
   def to_s
     "#{x}"
   end
 
+  # Returns a parseable version of the variable/expression for
+  # computer system modification.
+  #
+  # @return parseable form
   def parseable
     to_enum.map do |i|
       if Array === i
@@ -51,13 +86,17 @@ class Variable
   alias to_ary to_a
 end
 
+# Open class array
 class Array
+  # Public help for Variable#parseable
   def parseable
     Variable.new(self).parseable
   end
 end
 
+# Open class Symbol
 class Symbol
+  # Public help for Variable#parseable
   def parseable
     self
   end

metadata

@@ -1,21 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: ChebyRuby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Eli Sadoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-15 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies: []
-description: A gem for numerical analysis and scientific computing.
+description: |
+  This is a gem that is mainly for numerical analysis and especially
+  for applications of numerical analysis with regards to univariate
+  calculus. The future of this gem might entail expansion towards the
+  world of matrix analysis and multivariate calculus, but the primary
+  goal for the time being is univariate numerical calculus.
 email: snood1205@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- README.md
 - Rakefile
 - bin/chebyruby
 - lib/chebyruby.rb
@@ -34,14 +41,18 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "-t"
+- chebyruby RDocs
+- "-m"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -52,8 +63,7 @@ rubyforge_project:
 rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
-summary: A gem for numerical analysis and scientific computing.This is a pre-release
-  so beware.
+summary: A gem for numerical analysis and scientific computing.
 test_files:
 - test/test_function.rb
 - test/test_integration.rb