mathpack 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8697da38b49527c038d846912f468f313c8a6b4f
-  data.tar.gz: d6f4f88f6ea49ba317cdcab989cee5d8f838b28c
+  metadata.gz: f2feda03bce968d1a492dd5c6cfa99bfe1d8796c
+  data.tar.gz: 6b4908827c465f97ca042c266a393e8fb572ee94
 SHA512:
-  metadata.gz: 7cfa0c7f1baaaa08af5a3b9858ce04b563ab10c664c5f07813c9f17a2cd2933d35a73254c9d30ef4801854e4bedbe02397888a866f282009d9f5e186b8018418
-  data.tar.gz: 0f3733b6b9019d68a52220fbcfbcdd583e9aad45a3a70e2e05e394c6543dcf3d89dc71ce3c6c6b6ddf0512f9b4f9b07586ca97b9df0d623f496a1514488889e2
+  metadata.gz: e013b0cb1cb1339ca1b2572593b8d77dea7d4b11f678675a199125595b682f559a651d3d1ab807bb346e42084997b234bb1f969f503434be0ec5f69073adf6aa
+  data.tar.gz: 56d13a5f3c6fea715fa823e21197ef368d4591f5d3b83c250d56174d122d762a1cf81e1446788a9d2a7e054f1e5cc21d300555844d54c265ea506de758e10055

data/README.md

@@ -18,7 +18,8 @@ Or install it yourself as:
 
     $ gem install mathpack
 ## Information
-Gem `mathpack` allows to count statistical functions throught `Statistics` class
+Gem `mathpack` allows to count statistical functions through `Statistics` class, solving nonlinear equations through `Equation` module
+`solve` method
 ## Statistics
 `Statistics` class have following methods
 - **number** - returns a number of elements in series
@@ -32,20 +33,20 @@ Gem `mathpack` allows to count statistical functions throught `Statistics` class
 - **central_moment** - returns the *nth* central moment of series
 - **empirical_cdf** - returns *empirical distribution function* value in some point
 - **empirical_pdf** - returns *empirical probability density function* value in some point
-- **print_empirical_cdf_to_csv** - allows to print empirical_cdf grafic values to `.csv` file with name *filename*
-- **print_empirical_cdf_to_csv** - allows to print empirical_cdf grafic values to `.csv` file with name *filename*
+- **print_empirical_cdf_to_csv** - allows to print empirical_cdf line chart values to `.csv` file with name *filename*
+- **print_empirical_cdf_to_csv** - allows to print empirical_cdf line chart values to `.csv` file with name *filename*
 
-## Usage
+### Usage
 ```ruby
 stat = Mathpack::Statistics.new([1, 2, 5, 6])
 stat.number() #=> 4
 stat.mean() #=> 3.5
-stat.variance() #=> 4.25 
+stat.variance() #=> 4.25
 stat.kurtosis() #=> 1.221453287197232
 stat.skewness() #=> 0.0
 stat.min() #=> 1
 stat.max() #=> 6
-stat.raw_moment(3) #=> 87.5 
+stat.raw_moment(3) #=> 87.5
 stat.central_moment(4) #=> 22.0625
 stat.empirical_cdf(5.5) #=> 0.75
 stat.empirical_pdf(3) #=> 0.07639393483317147
@@ -53,6 +54,32 @@ stat.print_empirical_cdf_to_csv('cdf.csv') #=> nil
 stat.print_empirical_pdf_to_csv('pdf.csv') #=> nil
 ```
 
+##Equation
+`Equation` module has only one method
+- **solve** - method, which allows to solve *nonlinear equations*. Neccessary params are `eps` representing calculations accuraccy and `start` representing point to start root search
+
+###Usage
+Now you have no problems solving **nonlinear equations**. If you want, for example, to solve equation ![equation](http://latex.codecogs.com/gif.latex?x%5E%7B2%7D%20%3D%20%5Csin%28%7Bx+1%7D%29)
+
+You need to complete the following steps:
+1. Equation should look like 
+![equation](http://latex.codecogs.com/gif.latex?%5Ctiny%20f%28x%29%20%3D%200)
+2. For our equation ![equation](http://latex.codecogs.com/gif.latex?%5Csmall%20f%28x%29%20%3D%20x%5E%7B2%7D%20-%20%5Csin%28x+1%29)
+3. Choose the calculations accurracy. For example ![equation](http://latex.codecogs.com/gif.latex?%5Csmall%200.00001)
+4. Choose some point near the expected root of equation. For example ![equation](http://latex.codecogs.com/gif.latex?%5Csmall%200)
+
+Then to solve equation you should call 
+```ruby
+Mathpack::Equation.solve(start: 0, eps: 0.00001){|x| x**2 - Math.sin(x+1)})
+```
+Here is some examples of **solve** function usage
+```ruby
+Mathpack::Equation.solve(start: 0, eps: 0.00001){|x| x**2 - Math.sin(x+1)})
+Mathpack::Equation.solve(start: 0.01, eps: 0.00001){|x| 1/x - Math.log(x)})
+Mathpack::Equation.solve(start: 0.01, eps: 0.00001){|x| x**2 - 2*x + 1})
+Mathpack::Equation.solve(start: 0.01, eps: 0.00001){|x| Math.exp(x-2) - Math.sin(x)})
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/mathpack/fork )

data/lib/mathpack/equation.rb

@@ -0,0 +1,14 @@
+module Mathpack
+  module Equation
+    def self.solve(param = {}, &function)
+      derivate_eps = 1e-5
+      xk1 = param[:start]
+      loop do
+        xk = xk1
+        xk1 = xk - function.call(xk)/((function.call(xk + derivate_eps) - function.call(xk - derivate_eps))/(2*derivate_eps))
+        break if (xk1 - xk).abs < param[:eps]
+      end
+      return xk1
+    end
+  end
+end

data/lib/mathpack/version.rb

@@ -1,3 +1,3 @@
 module Mathpack
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/mathpack.rb

@@ -1,2 +1,3 @@
 require "mathpack/version"
-require 'statistics'
+require 'mathpack/statistics'
+require 'mathpack/equation'

data/spec/equation_spec.rb

@@ -0,0 +1,14 @@
+describe 'Equations' do
+  require 'mathpack/equation'
+
+  context 'calculate nonlinear equations' do
+
+    it 'should solve equation' do
+      eps = 0.00001
+      expect(Mathpack::Equation.solve(start: 0, eps: eps){|x| x**2 - Math.sin(x+1)}).to be_between(-0.613763 - eps, -0.613763 + eps)
+      expect(Mathpack::Equation.solve(start: 0.01, eps: eps){|x| 1/x - Math.log(x)}).to be_between(1.76322 - eps, 1.76322 + eps)
+      expect(Mathpack::Equation.solve(start: 0.01, eps: eps){|x| x**2 - 2*x + 1}).to    be_between(1.0 - eps, 1.0 + eps)
+      expect(Mathpack::Equation.solve(start: 0.01, eps: eps){|x| Math.exp(x-2) - Math.sin(x)}).to    be_between(0.159396 - eps, 0.159396 + eps)
+    end
+  end
+end

data/spec/statistics_spec.rb

@@ -1,7 +1,7 @@
 describe 'Statistics' do
-  require 'statistics'
+  require 'mathpack/statistics'
 
-  context "calculated using class methods" do
+  describe "calculated statistics functions" do
 
     let(:data) { [1,5,4,2,3,4,5,7,2,7] }
     let(:stat) { Mathpack::Statistics.new(data) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mathpack
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - maxmilan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-27 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,9 +52,11 @@ files:
 - README.md
 - Rakefile
 - lib/mathpack.rb
+- lib/mathpack/equation.rb
+- lib/mathpack/statistics.rb
 - lib/mathpack/version.rb
-- lib/statistics.rb
 - mathpack.gemspec
+- spec/equation_spec.rb
 - spec/statistics_spec.rb
 homepage: ''
 licenses:
@@ -81,4 +83,5 @@ signing_key:
 specification_version: 4
 summary: Summary
 test_files:
+- spec/equation_spec.rb
 - spec/statistics_spec.rb