complexity_assert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c1beec0306dbe6397d5e7bea540b2318bcf3e42
+  data.tar.gz: 8702d7efa30addc10485249b41da6a5b9d3f0f5d
+SHA512:
+  metadata.gz: b61547c46110de77a353b6a8a6098466d67d699cc3fda89f07bdcf6f3eef9baee18768372d151634fe4416129fcbf5f78bbe42531694b1204ee7ab6ee6ffd4a5
+  data.tar.gz: 5545bdc7d640c3b1830f341c9e7bb06268e80eff25641085a433a62f8283335da010d4b8a276a11c7f95e219216ac3854e7c719be0519190e881adcaa09997d6

data/.gitignore

@@ -0,0 +1,77 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Emacs files
+*~
+*#
+.#*
+
+# Gemfile.lock
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.4

data/DayBook.org

@@ -0,0 +1,92 @@
+* DONE build an assert for a linear algorithm
+** DONE play with the thing, and print first results
+** DONE O(x) algorithms : do a simple Ordinary Least Squares
+*** DONE disable GC for the moment
+*** DONE deal with warmup
+**** DONE find a way to know if my new algo is better than the previous one
+***** DONE have an arena, it generates validating samples, runs the 2 algos, then compares the distance on validation inputs
+****** DONE compute the rmse
+****** DONE split the classes to files
+***** What parameters do I already have ?
+****** distribution of input sizes
+****** number of runs
+****** GC or not
+****** warmup or not
+**** DONE dump csvs to know how the error changes with the algos
+**** DONE detect whether warmup has a consequence
+***** It Does. Particularly on small number of runs.
+***** Even in the same process, we can spot a difference
+***** Once we know if it is important, let's just use it all the time
+***** It might be depending on the algorithm ! the number of time some parts are looped over during the run.
+***** [OK] On our linear search, around 60 warmup rounds are required to reduce variability
+***** DONE play with different counts of warmup rounds
+** DONE O(1) : identify the flat slope
+*** DONE not sure a transformation is possible for a regression, otherwise, just do an average
+*** DONE predict is just returning the average
+*** DONE print and compare the results
+*** DONE try with a constant algorithm to test
+** DONE need to rule out very small coefs, could find a quadratic with a small coef !
+*** 12 times on 55, found linear better than constant, only finds constant 80% of times
+*** to compare RMSE corretly, they shouls be normalized, or using the same data points
+*** DONE reuse the same data for training and validation
+*** If we had an idea of the max size we would like to use it for, we could check that at that size, coeff is still irrelevant
+| algo          | slope | y intercept | at 1000 |
+|---------------+-------+-------------+---------|
+| random 5      | E-10  | E-6         | +10%    |
+| linear search | E-7   | E-7         | *1000   |
+*** Compute the error we can expect from our data sample, and use it to determine what is 0 or not
+**** Don't know how to do it !
+**** One thing is that negative slopes are zero !
+*** See how it goes with quadratic
+*** Could we use special assertion be_constant(within: constraints)
+*** It's a case of overfitting in fact !
+**** We can give benefit of the doubt to the simpler model.
+**** The more complex model needs to give an RMSE half the one of the simpler model to be selected
+**** This works well on practice with Random5 and LinearSearch
+** DONE O(x2) : pre-treat with an sqrt before OLS, compare RMSE of both linear and quadratic models to see which one is best
+*** DONE write a quadratic algorithm
+*** DONE add QuadraticComplexityModel
+**** A = Qn2 + C
+**** reg : sqrt(A) = Ln + D
+**** reg : A = L2n2 + 2LDn + D2
+*** DONE select the best and see if it works
+**** Needs to be twice as better as the next one !
+**** have all rmse in order of complexity (constant, linear, quadratic, etc)
+**** go through all starting from the first. Keep the min rmse
+**** if a new rmse is found smaller than half the min, we'll pick this one
+*** Sometimes, if finds O(n) instead of O(n²). Maybe that's not so much of an issue if the assertion checks that it's at worst O(n²)
+** DONE Add +7 pomodoro to the task title
+** DONE write the basic rspec integration
+*** DONE define the API we want
+**** class Algorithm; def generate_args(n) ...; def run(args) ...; end;
+**** expect(Algorithm).to be_linear()
+**** expect(Algorithm).to be_constant()
+**** expect(Algorithm).to be_quadratic()
+**** expect(Algorithm).to be_logarithmic()
+**** expect(Algorithm).to be_in(N*LN(N))
+**** expect(Algorithm, warmups: 30, rounds: 20, sizes: [...]).to be_xxx() or expect(Algorithm).to be_xxx(warmups: 30, rounds: 20, sizes: [...])
+*** DONE determine the condition
+**** compare with constant
+***** simple to do ! not sure it works :
+| algorithm | expect constant                                                       | expect linear                         |
+|-----------+-----------------------------------------------------------------------+---------------------------------------|
+| constant  | regress both, find constant is better or linear with very small slope | will find a very small slope          |
+| linear    | should fail                                                           | should pass, but might be quadratic ! |
+***** checking constant is checking that is not worse than constant eg : linear or log
+***** they can all be coded with transformations to the timings
+****** constant : remove the size, keep the timing
+****** linear : identity
+****** logarithmic : some kind of exponential
+****** quadratic : some kind of squar root
+**** We just need to assert that it's at worst O(something).
+*** DONE Get an internet access
+*** DONE fill the readme
+*** DONE Check that the gem is well formed
+*** DONE download rspec
+*** DONE move the files around
+*** DONE write a few specs to make sure it works
+*** DONE see how to create matchers with rspec3
+*** DONE move the matchers to the lib
+*** DONE add a module namespace
+*** DONE add travis
+*** DONE just submit

data/Dockerfile

@@ -0,0 +1 @@
+FROM ruby:2.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in complexity_assert.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,109 @@
+# ComplexityAssert
+
+They are some performance critical pieces of code that will be executed on huge data sets, which we want to make sure will run fast enough. Unfortunately, enforcing this is not easy, often requiring large scale and slow benchmarks. This [RSpec](http://rspec.info/) library (the result of an experiment to learn machine learning) uses linear regression to determine the time complexity ([Big O notation](http://bigocheatsheet.com/), O(x)) of a piece of code and to check that it is at least as good as what we expect. This does not require huge data sets (only a few large ones) and can be written as any unit test (not as fast though).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'complexity_assert', :group => [:test]
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install complexity_assert
+
+## Usage
+
+In order to test the complexity of an algorithm, you need to provide 2 things :
+
+1. the algorithm
+2. a way to generate some inputs of varying size
+
+For this, you need to provide an object that answers to messages `generate_args` and `run`. Here is an example
+
+``` ruby
+# An adapter class to fit the code to measure in complexity assert
+class LinearSearch
+
+  # Generate some arguments of a particular size
+  def generate_args(size)
+    [ Array.new(size) { rand(1..size) }, rand(1..size) ]
+  end
+
+  # Run the code on which we want to assert performance
+  def run(array, searched)
+    found = false;
+    array.each do |element|
+      if element == array
+        found = true
+      end
+    end
+    found
+  end
+end
+
+describe "Linear search" do
+
+  it "performs linearly" do
+    # Verify that the code runs in time proportional to the size of its arguments
+    expect(LinearSearch.new).to be_linear()
+  end
+
+end
+```
+
+There are currently 3 matchers :
+
+* be_constant
+* be_linear
+* be_quadratic
+
+More could be added in the future. Every matcher passes if a faster complexity is identified (`be_linear` willalso pass if the algorithm is detected to be constant).
+
+That means that for the moment, `be_quadratic` always passes, but might turn out useful when we add more complex models (Internally, it is quite useful, as it is used to identify that something is more linear than quadratic !).
+
+## Development
+
+It uses rubybox, simply clone this repo, build the image, and start on.
+
+```
+git clone ...
+cd ...
+docker-compose build
+docker-compose run rubybox
+```
+
+From then on, you're inside the ruby box, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/complexity_assert.
+
+Here is a quick and uncomplete list of things that could improve this library :
+
+* Add Code Climate
+* Refactor some code around the matchers
+* Cache the linear regression (it's done twice)
+* Factorize / find a way to better generate the sizes, or allow the assertion to specify the sizes
+* Allow the assertion to specify the warmup and run rounds
+* Robustness against GC : use gc intensive ruby methods, and see how the regression behaves
+* O(lnx) : pre-treat with exp()
+* O(?lnx) : use exp, then a search for the coefficient (aka polynomial)
+* O(xlnx) : there is no well known inverse for that, we can compute it numericaly though
+* O(x?) : do some kind of dichotomy or search to find the most probable model
+* Estimate how much the assert is deterministic
+* ...
+
+As I said, this is still experimental ! Any help is welcome !
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "complexity_assert"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/complexity_assert.gemspec

@@ -0,0 +1,33 @@
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'complexity_assert/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "complexity_assert"
+  spec.version       = ComplexityAssert::VERSION
+  spec.authors       = ["Philippe Bourgau"]
+  spec.email         = ["philippe.bourgau@gmail.com"]
+
+  spec.summary       = %q{An experimental rspec library to check the time complexity (Big O(x) notation) of an algorithm.}
+  spec.description   = %q{They are some performance critical pieces of code that will be executed on huge data sets, which we want to make sure will run fast enough. Unfortunately, enforcing this is not easy, often requiring large scale and slow benchmarks. This rspec library (the result of an experiment to learn machine learning) uses linear regression to determine the time complexity (Big O notation, O(x)) of a piece of code and to check that it is at least as good as what we expect. This does not require huge data sets (only a few large ones) and can be written as any unit test (not as fast though).}
+  spec.homepage      = "https://github.com/philou/complexity-assert"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.5"
+
+  spec.add_development_dependency "bundler", ">= 1.12"
+  spec.add_development_dependency "rake", ">= 10.0"
+end

data/docker-compose.yml

@@ -0,0 +1,11 @@
+rubybox:
+  image: ruby:2.3
+  command: bash
+  working_dir: /usr/src/app
+  environment:
+  #  PORT: 8080
+    BUNDLE_PATH: 'vendor/bundle'
+  # ports:
+  #   - '8080:8080'
+  volumes:
+    - '.:/usr/src/app'

data/lib/complexity_assert.rb

@@ -0,0 +1,14 @@
+require "complexity_assert/version"
+
+require "complexity_assert/complexity_validator"
+require "complexity_assert/constant_complexity_model"
+require "complexity_assert/linear_complexity_model"
+require "complexity_assert/quadratic_complexity_model"
+require "complexity_assert/sampler"
+require "complexity_assert/simple_linear_regression"
+require "complexity_assert/warmup_sampler"
+require "complexity_assert/matchers"
+
+module ComplexityAssert
+  # Your code goes here...
+end

data/lib/complexity_assert/complexity_validator.rb

@@ -0,0 +1,26 @@
+
+module ComplexityAssert
+
+  # Generates a sample of execution timings to compute the RMSE of complexity models, in order to valide them
+  class ComplexityValidator
+
+    def initialize(sampler, complexity_models)
+      @sampler = sampler
+      @complexity_models = complexity_models
+    end
+
+    def rmses
+      # TODO these sizes are duplicated with the Matchers
+      data = @sampler.run([8,10,12,80,100,120,800,1000,1200],10)
+
+      @complexity_models.map do |model|
+        rmse = Math.sqrt(data.map { |size, real_time|
+                           (real_time - model.predict_run_time(size))**2
+                         }.reduce &:+)
+        [ model.to_s, rmse]
+      end
+    end
+
+  end
+
+end

data/lib/complexity_assert/constant_complexity_model.rb

@@ -0,0 +1,21 @@
+module ComplexityAssert
+
+  # computes the average of the time spent in order to predict future execution time
+  class ConstantComplexityModel
+
+    def analyze(timings)
+      sum = timings.map { |size_runtime| size_runtime[1] }.inject &:+
+      @average = sum / timings.size
+    end
+
+    def predict_run_time(input_data_size)
+      @average
+    end
+
+    def to_s
+      'O(1)'
+    end
+
+  end
+
+end

data/lib/complexity_assert/linear_complexity_model.rb

@@ -0,0 +1,21 @@
+module ComplexityAssert
+  # Generates a sample of execution timings to run a linear regression in order to predict another execution time
+  class LinearComplexityModel
+
+    def analyze(timings)
+      linear_model = SimpleLinearRegression.new(*timings.transpose)
+      @slope = linear_model.slope
+      @y_intercept = linear_model.y_intercept
+    end
+
+    def predict_run_time(input_data_size)
+      @y_intercept + @slope * input_data_size
+    end
+
+    def to_s
+      "O(n)"
+    end
+
+  end
+
+end

data/lib/complexity_assert/matchers.rb

@@ -0,0 +1,73 @@
+require 'rspec/expectations'
+
+module ComplexityAssert
+
+  class Matchers
+    # complexity_errors : [["big O notation", rmse score], ...], in order of complexity costs
+    def self.best_complexity_by_rmse(complexity_errors)
+      best = complexity_errors.first
+      complexity_errors.drop(1).each do |comp_error|
+
+        # we favor simpler complexities to fight overfitting from more elaborate models
+        if comp_error[1] < best[1] / 2
+          best = comp_error
+        end
+      end
+      best[0]
+    end
+
+    private
+
+    def self.identify_complexity(algo)
+      sampler = WarmupSampler.new(Sampler.new(algo),60)
+      # These sizes are duplicated with the ComplexityValidator
+      timings = sampler.run([8,10,12,80,100,120,800,1000,1200], 10)
+      complexity_models = [
+        ConstantComplexityModel.new(),
+        LinearComplexityModel.new(),
+        QuadraticComplexityModel.new()
+      ]
+
+      complexity_models.each { |model| model.analyze(timings) }
+      validator = ComplexityValidator.new(sampler, complexity_models)
+
+      rmses = validator.rmses
+
+      best_complexity_by_rmse(rmses)
+    end
+  end
+
+  # TODO
+  # - factorize code of these matchers
+  # - stop using the "O(x)" magic constants (they are the XXXComplexityModel.to_s)
+
+  RSpec::Matchers.define :be_constant do
+    match do |actual|
+      @actual_complexity = Matchers.identify_complexity(actual)
+      ["O(1)"].include?(@actual_complexity)
+    end
+    failure_message do |actual|
+      "expect that #{actual} would have a complexity equal or better than O(1) but was #{@actual_complexity}"
+    end
+  end
+
+  RSpec::Matchers.define :be_linear do
+    match do |actual|
+      @actual_complexity = Matchers.identify_complexity(actual)
+      ["O(1)","O(n)"].include?(@actual_complexity)
+    end
+    failure_message do |actual|
+      "expect that #{actual} would have a complexity equal or better than O(n) but was #{@actual_complexity}"
+    end
+  end
+
+  RSpec::Matchers.define :be_quadratic do
+    match do |actual|
+      @actual_complexity = Matchers.identify_complexity(actual)
+      ["O(1)","O(n)","O(n^2)"].include?(@actual_complexity)
+    end
+    failure_message do |actual|
+      "expect that #{actual} would have a complexity equal or better than O(n^2) but was #{@actual_complexity}"
+    end
+  end
+end

data/lib/complexity_assert/quadratic_complexity_model.rb

@@ -0,0 +1,30 @@
+module ComplexityAssert
+
+  # Generates a sample of execution timings to run a linear regression in order to predict another execution time
+  class QuadraticComplexityModel
+
+    # timings : [[size,timing], ...]
+    def analyze(timings)
+      sqrt_timings = timings.map do |size, timing|
+        [size, Math.sqrt(timing)]
+      end
+      linear_model = SimpleLinearRegression.new(*sqrt_timings.transpose)
+      sqrt_slope = linear_model.slope
+      sqrt_y_intercept = linear_model.y_intercept
+
+      @quadratic = sqrt_slope * sqrt_slope
+      @slope = 2* sqrt_slope * sqrt_y_intercept
+      @y_intercept = sqrt_y_intercept * sqrt_y_intercept
+    end
+
+    def predict_run_time(input_data_size)
+      @y_intercept + @slope * input_data_size + @quadratic * input_data_size * input_data_size
+    end
+
+    def to_s
+      'O(n^2)'
+    end
+
+  end
+
+end

data/lib/complexity_assert/sampler.rb

@@ -0,0 +1,30 @@
+require "benchmark"
+
+module ComplexityAssert
+
+  class Sampler
+    def initialize(algo_under_test)
+      @algo_under_test = algo_under_test
+    end
+
+    # Generates an array of sample data points
+    # [ [input size, real time], ... ]
+    def run(sizes, rounds)
+      sizes.flat_map { |size | run_for_size(size, rounds) }
+    end
+
+    private
+
+    def run_for_size(size, rounds)
+      Array.new(rounds) do
+        args = @algo_under_test.generate_args(size)
+        GC.disable
+        real_time = Benchmark.realtime { @algo_under_test.run(*args) }
+        GC.enable
+        [size, real_time]
+      end
+    end
+
+  end
+
+end

data/lib/complexity_assert/simple_linear_regression.rb

@@ -0,0 +1,40 @@
+
+module ComplexityAssert
+
+  # Performs basic linear regression on a set of points
+  class SimpleLinearRegression
+    def initialize(xs, ys)
+      @xs, @ys = xs, ys
+      if @xs.length != @ys.length
+        raise "Unbalanced data. xs need to be same length as ys"
+      end
+    end
+
+    # TODO cache all these instead of computing it every time
+
+    def y_intercept
+      mean(@ys) - (slope * mean(@xs))
+    end
+
+    def slope
+      x_mean = mean(@xs)
+      y_mean = mean(@ys)
+
+      numerator = (0...@xs.length).reduce(0) do |sum, i|
+        sum + ((@xs[i] - x_mean) * (@ys[i] - y_mean))
+      end
+
+      denominator = @xs.reduce(0) do |sum, x|
+        sum + ((x - x_mean) ** 2)
+      end
+
+      (numerator / denominator)
+    end
+
+    def mean(values)
+      total = values.reduce(0) { |sum, x| x + sum }
+      Float(total) / Float(values.length)
+    end
+  end
+
+end

data/lib/complexity_assert/version.rb

@@ -0,0 +1,3 @@
+module ComplexityAssert
+  VERSION = "0.1.0"
+end

data/lib/complexity_assert/warmup_sampler.rb

@@ -0,0 +1,15 @@
+module ComplexityAssert
+
+  # A sampler wrapper that does some warmup on the algo under test
+  class WarmupSampler
+    def initialize(sampler, rounds)
+      @sampler = sampler
+      @rounds = rounds
+    end
+
+    def run(sizes, count)
+      _warmup_data = @sampler.run(sizes,@rounds)
+      @sampler.run(sizes,count)
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: complexity_assert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philippe Bourgau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: They are some performance critical pieces of code that will be executed
+  on huge data sets, which we want to make sure will run fast enough. Unfortunately,
+  enforcing this is not easy, often requiring large scale and slow benchmarks. This
+  rspec library (the result of an experiment to learn machine learning) uses linear
+  regression to determine the time complexity (Big O notation, O(x)) of a piece of
+  code and to check that it is at least as good as what we expect. This does not require
+  huge data sets (only a few large ones) and can be written as any unit test (not
+  as fast though).
+email:
+- philippe.bourgau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- DayBook.org
+- Dockerfile
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- complexity_assert.gemspec
+- docker-compose.yml
+- lib/complexity_assert.rb
+- lib/complexity_assert/complexity_validator.rb
+- lib/complexity_assert/constant_complexity_model.rb
+- lib/complexity_assert/linear_complexity_model.rb
+- lib/complexity_assert/matchers.rb
+- lib/complexity_assert/quadratic_complexity_model.rb
+- lib/complexity_assert/sampler.rb
+- lib/complexity_assert/simple_linear_regression.rb
+- lib/complexity_assert/version.rb
+- lib/complexity_assert/warmup_sampler.rb
+- visu.ods
+homepage: https://github.com/philou/complexity-assert
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: An experimental rspec library to check the time complexity (Big O(x) notation)
+  of an algorithm.
+test_files: []