nth_permutation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70fb61dd1639af9f5427ebad985fde1d9154eb7c
+  data.tar.gz: 33a32853d5334caa178989d33f0e99cb31c86e54
+SHA512:
+  metadata.gz: 7d7e510e18d99b51313e6f1741f47f55f2f53a9440703e594eb667a9aac77c64a3852ec851dc9b775b12e1f48d819767aaf889ee73f0cb77492c1b8e2b884a1c
+  data.tar.gz: 366fe29d549705bfe5633846e95381bf372437d818c765936da9e56c95254c4c1b9ee534a842c66862d0e0657df735c683c6810329767a7eecded14df8c347fa

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: cLGXVCqLrmplxb7TwmmGSwAW57IsXaoC9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tanvir002700@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nth_permutation.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    nth_permutation (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
+    rake (10.5.0)
+    rake-compiler (1.0.4)
+      rake
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coveralls (~> 0.8.21)
+  nth_permutation!
+  rake (~> 10.0)
+  rake-compiler (~> 1.0, >= 1.0.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 tanvir hasan
+
+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,56 @@
+# NthPermutation
+[![Build Status](https://travis-ci.org/tanvir002700/nth_permutation.svg?branch=master)](https://travis-ci.org/tanvir002700/nth_permutation)
+[![Maintainability](https://api.codeclimate.com/v1/badges/69f40101eeb294c05163/maintainability)](https://codeclimate.com/github/tanvir002700/nth_permutation/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/tanvir002700/nth_permutation/badge.svg?branch=master)](https://coveralls.io/github/tanvir002700/nth_permutation?branch=master)
+[![Gem Version](https://badge.fury.io/rb/nth_permutation.svg)](https://badge.fury.io/rb/nth_permutation)
+[![Downloads](https://img.shields.io/gem/dt/nth_permutation.svg)](https://rubygems.org/gems/nth_permutation)
+[![GitHub last commit (branch)](https://img.shields.io/github/last-commit/tanvir002700/nth_permutation/master.svg)](https://github.com/tanvir002700/nth_permutation)
+[![license](https://img.shields.io/github/license/tanvir002700/nth_permutation.svg)](https://github.com/tanvir002700/nth_permutation/blob/master/LICENSE)
+
+This gem is NthPermutation implemanted with c Extension. A super first permutation finding library in ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nth_permutation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nth_permutation
+
+## Usage
+
+``` ruby
+require nth_permutation
+p = NthPermutation::String.new 'abc'
+p.permutation 2 #=> 'acb'
+p.possible_permutation #=> 6
+```
+## Limitation
+
+Can't handle more than 20 character longer string.
+
+## Development
+
+After checking out the repo, 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/tanvir002700/nth-permutation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Nth::Permutation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tanvir002700/nth-permutation/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new "nth_permutation" do |ext|
+  ext.lib_dir = "lib/nth_permutation"
+end
+
+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 "nth_permutation"
+
+# 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(__FILE__)

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/ext/nth_permutation/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile "nth_permutation/nth_permutation"

data/ext/nth_permutation/nth_permutation.c

@@ -0,0 +1,14 @@
+#include<ruby.h>
+#include<permutation_string.h>
+
+VALUE test()
+{
+    return rb_str_new2("test method");
+}
+
+void Init_nth_permutation()
+{
+    VALUE mNthPermutation = rb_define_module("NthPermutation");
+    rb_define_singleton_method(mNthPermutation, "test", test, 0);
+    Init_permutation_string(mNthPermutation);
+}

data/ext/nth_permutation/permutation_string.c

@@ -0,0 +1,142 @@
+#include<ruby.h>
+#include<string.h>
+
+const int CHACARTERS = 257;
+const int LIMIT = 21;
+
+struct Str
+{
+    long long int * factorial;
+    long long int possible_permutation;
+    int * frequency;
+    char *ptr;
+    int len;
+};
+
+static void deallocate(struct Str *str)
+{
+    if(str->factorial) free(str->factorial);
+    if(str->frequency) free(str->frequency);
+    if(str->ptr) free(str->ptr);
+    free(str);
+}
+
+static VALUE allocate(VALUE klass)
+{
+    struct Str * str = (struct Str *)malloc(sizeof(struct Str));
+    VALUE obj = Data_Make_Struct(klass, struct Str, NULL, deallocate, str);
+    str->ptr = NULL;
+    str->factorial = NULL;
+    str->frequency = NULL;
+    str->len = 0;
+    str->possible_permutation = 0;
+    return obj;
+}
+
+int * factorial()
+{
+    long long int * fact = (long long int *) calloc(LIMIT, sizeof(long long int));
+
+    fact[0] = 1;
+    for(int i=1; i<LIMIT; i++) fact[i] = fact[i-1] * i;
+
+    return fact;
+}
+
+int * frequency(char * str)
+{
+    int * freq = (int *) calloc(CHACARTERS, sizeof(int));
+    for(int i=0; str[i]; i++) freq[str[i]]++;
+    return freq;
+}
+
+long long int number_of_permutation(const long long int * factorial, const int * freq, int len)
+{
+    long long int fact = factorial[len];
+    for(int i=0; i<CHACARTERS; i++) fact /= factorial[freq[i]];
+    return fact;
+}
+
+static VALUE permutation(VALUE self, VALUE rb_nth)
+{
+    struct Str * str;
+    Data_Get_Struct(self, struct Str, str);
+
+    Check_Type(rb_nth, T_FIXNUM);
+    long long int nth = NUM2LL(rb_nth);
+    if(nth > str->possible_permutation) rb_raise(rb_eRangeError, "there's no such nth permutation.");
+    if(nth < 0) rb_raise(rb_eRangeError, "negative term of permutation isn't possible.");
+
+    int * freq = (int *) calloc(CHACARTERS, sizeof(int));
+    memcpy(freq, str->frequency, CHACARTERS*sizeof(int));
+
+    int len = strlen(str->ptr);
+
+    char * nth_permutation = (char *) calloc(len + 1, sizeof(char));
+    int indx = 0;
+
+    while(len)
+    {
+        long long upto = 0;
+        for(int i=0; i<CHACARTERS; i++)
+        {
+            if(!freq[i])continue;
+            freq[i] -= 1;
+
+            long long int now_permutation = number_of_permutation(str->factorial, freq, len-1);
+            if(upto + now_permutation >= nth)
+            {
+                nth -= upto;
+                nth_permutation[indx++] = (char) i;
+                len--;
+                break;
+            }
+            else
+            {
+                upto += now_permutation;
+                freq[i] += 1;
+            }
+        }
+    }
+    nth_permutation[str->len] = NULL;
+
+    free(freq);
+
+    return rb_str_new2(nth_permutation);
+}
+
+static VALUE initialize(VALUE self, VALUE rb_string)
+{
+    struct Str * str;
+
+    Check_Type(rb_string, T_STRING);
+    if(RSTRING_LEN(rb_string) >= LIMIT) rb_raise(rb_eRangeError, "can't handle more than 20 character length string");
+    Data_Get_Struct(self, struct Str, str);
+
+    str->ptr = calloc(RSTRING_LEN(rb_string) + 1 , sizeof(char));
+    memcpy(str->ptr, StringValuePtr(rb_string), RSTRING_LEN(rb_string));
+
+    str->len = strlen(str->ptr);
+    str->factorial = factorial();
+    str->frequency = frequency(str->ptr);
+    str->possible_permutation = number_of_permutation(str->factorial, str->frequency, str->len);
+
+    rb_iv_set(self, "@str", rb_string);
+    rb_iv_set(self, "@length", INT2NUM(RSTRING_LEN(rb_string)));
+    rb_iv_set(self, "@possible_permutation", LL2NUM(str->possible_permutation));
+
+    return self;
+}
+
+void Init_permutation_string(VALUE mNthPermutation)
+{
+    VALUE cPermutationString = rb_define_class_under(mNthPermutation, "String", rb_cObject);
+
+    rb_define_alloc_func(cPermutationString, allocate);
+    rb_define_method(cPermutationString, "initialize", initialize, 1);
+    rb_define_method(cPermutationString, "permutation", permutation, 1);
+    rb_define_attr(cPermutationString, "str", 1, 0);
+    rb_define_attr(cPermutationString, "length", 1, 0);
+    rb_define_attr(cPermutationString, "possible_permutation", 1, 0);
+}
+

data/ext/nth_permutation/permutation_string.h

@@ -0,0 +1,8 @@
+#ifndef KPERMUTATION_STRING
+#define KPERMUTATION_STRING
+
+#include<ruby.h>
+
+void Init_permutation_string(VALUE mNthPermutation);
+#endif
+

data/lib/nth_permutation.rb

@@ -0,0 +1,3 @@
+require 'nth_permutation/version'
+require 'nth_permutation/string'
+require 'nth_permutation/nth_permutation'

data/lib/nth_permutation/string.rb

@@ -0,0 +1,7 @@
+module NthPermutation
+  class String
+    def inspect
+      str
+    end
+  end
+end

data/lib/nth_permutation/version.rb

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

data/nth_permutation.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nth_permutation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nth_permutation"
+  spec.version       = NthPermutation::VERSION
+  spec.authors       = ["tanvir hasan"]
+  spec.email         = ["tanvir002700@gmail.com"]
+
+  spec.summary       = %q{A permutation finding library in Ruby.}
+  spec.description   = %q{Nth permutation finding algorithm, which is implemented in ruby c-extension.}
+  spec.homepage      = "https://rubygems.org/gems/nth_permutation"
+  spec.license       = "MIT"
+  spec.metadata      = { 'source_code_uri' => 'https://github.com/tanvir002700/nth_permutation' }
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency 'coveralls', '~> 0.8.21'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rake-compiler', '~> 1.0', '>= 1.0.0'
+  spec.extensions = %w[ext/nth_permutation/extconf.rb]
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: nth_permutation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tanvir hasan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Nth permutation finding algorithm, which is implemented in ruby c-extension.
+email:
+- tanvir002700@gmail.com
+executables: []
+extensions:
+- ext/nth_permutation/extconf.rb
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/nth_permutation/extconf.rb
+- ext/nth_permutation/nth_permutation.c
+- ext/nth_permutation/permutation_string.c
+- ext/nth_permutation/permutation_string.h
+- lib/nth_permutation.rb
+- lib/nth_permutation/nth_permutation.so
+- lib/nth_permutation/string.rb
+- lib/nth_permutation/version.rb
+- nth_permutation.gemspec
+homepage: https://rubygems.org/gems/nth_permutation
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/tanvir002700/nth_permutation
+  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.11
+signing_key: 
+specification_version: 4
+summary: A permutation finding library in Ruby.
+test_files: []