dartsclone 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ffd79764c75c8fd8c2b7dc55b5f80c3875a0641420f05a9d1e07d701ffc15a17
+  data.tar.gz: 70799ddcdb885b78fa338a36b28063df1ae41a0f87d3be6a1aad8faec8b939a7
+SHA512:
+  metadata.gz: af070c15bc7b53a58d06200a2a8da7ce931161c470248f43a80365af3323122db200fa467bce0fe738d5ecfbd1dde8865733c37a27dcf7d00f5c8947341feeef
+  data.tar.gz: d4bad89bbbb9b2a7c8aa0defb663e56db7cbdae2a934308ebb86c8ad4ddc24a8d659722186b1ce9de4ce1f4faeaefb17821f1564ec54865e668813ca06617994

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.swp
+mkmf.log
+tags
+.DS_Store
+.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+os: linux
+dist: xenial
+language: ruby
+cache: bundler
+rvm:
+  - '2.5'
+  - '2.6'
+  - '2.7'
+
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+- First release.

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 yoshoku@outlook.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in darts.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rake-compiler"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2020 Atsushi Tatsuma
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,64 @@
+# Darts-clone.rb
+
+[![Build Status](https://travis-ci.org/yoshoku/darts-clone.rb.svg?branch=master)](https://travis-ci.org/yoshoku/darts-clone.rb)
+[![Gem Version](https://badge.fury.io/rb/dartsclone.svg)](https://badge.fury.io/rb/dartsclone)
+[![BSD 2-Clause License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://github.com/yoshoku/darts-clone.rb/blob/master/LICENSE.txt)
+
+Darts-clone.rb is a Ruby binding for the [Darts-clone](https://github.com/s-yata/darts-clone).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dartsclone'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dartsclone
+
+## Usage
+
+```ruby
+require 'dartsclone'
+
+da = DartsClone::DoubleArray.new
+
+# Construct a dictionary.
+keys = ['abc', 'abcd', 'abcde', 'bcd', 'cde']
+da.build(keys)
+
+# Search for keys which match the prefix of given string.
+p da.common_prefix_search('abcde')
+# => [["abc", "abcd", "abcde"], [0, 1, 2]]
+
+# Search a key which matches a given string.
+p da.exact_match_search('abcd')
+# => 1
+
+# Dump the dictionary.
+da.save('foo.dat')
+
+# Load the dictionary.
+da.open('foo.dat')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/darts-clone.rb.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/yoshoku/darts-clone.rb/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [BSD 2-clause License](https://opensource.org/licenses/BSD-2-Clause).
+Moreover, the gem includes the source code of Darts-clone.
+The License of Darts-clone can be found in [COPYING.md](https://github.com/yoshoku/darts-clone.rb/blob/master/ext/dartsclone/src/COPYING.md).
+
+## Code of Conduct
+
+Everyone interacting in the Darts project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/darts-clone.rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rake/extensiontask'
+
+task :build => :compile
+
+Rake::ExtensionTask.new('dartscloneext') do |ext|
+  ext.ext_dir = 'ext/dartsclone'
+  ext.lib_dir = 'lib/dartsclone'
+end
+
+task :default => [:clobber, :compile, :spec]

data/dartsclone.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/dartsclone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dartsclone'
+  spec.version       = DartsClone::VERSION
+  spec.authors       = ['yoshoku']
+  spec.email         = ['yoshoku@outlook.com']
+
+  spec.summary       = 'Ruby binding for the Darts-clone.'
+  spec.description   = 'Darts-clone.rb is a Ruby binding for the Darts-clone.'
+  spec.homepage      = 'https://github.com/yoshoku/darts-clone.rb'
+  spec.license       = 'BSD-2-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/darts-clone.rb/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.extensions    = ['ext/dartsclone/extconf.rb']
+end

data/ext/dartsclone/dartscloneext.cpp

@@ -0,0 +1,8 @@
+#include "dartscloneext.hpp"
+
+extern "C"
+void Init_dartscloneext(void)
+{
+  VALUE rb_mDarts = rb_define_module("DartsClone");
+  RbDoubleArray::define_class(rb_mDarts);
+}

data/ext/dartsclone/dartscloneext.hpp

@@ -0,0 +1,229 @@
+#ifndef DARTSCLONEEXT_HPP
+#define DARTSCLONEEXT_HPP 1
+
+#include <ruby.h>
+#include <darts.h>
+
+class RbDoubleArray
+{
+  public:
+    static VALUE double_array_alloc(VALUE self) {
+      Darts::DoubleArray* ptr = (Darts::DoubleArray*)ruby_xmalloc(sizeof(Darts::DoubleArray));
+      return Data_Wrap_Struct(self, NULL, double_array_free, ptr);
+    };
+
+    static void double_array_free(Darts::DoubleArray* ptr) {
+      ptr->~DoubleArrayImpl();
+      ruby_xfree(ptr);
+    };
+
+    static Darts::DoubleArray* get_double_array(VALUE self) {
+      Darts::DoubleArray* ptr;
+      Data_Get_Struct(self, Darts::DoubleArray, ptr);
+      return ptr;
+    };
+
+    static VALUE define_class(VALUE rb_mDarts) {
+      VALUE rb_cDoubleArray = rb_define_class_under(rb_mDarts, "DoubleArray", rb_cObject);
+      rb_define_alloc_func(rb_cDoubleArray, double_array_alloc);
+      rb_define_method(rb_cDoubleArray, "initialize", RUBY_METHOD_FUNC(_double_array_init), 0);
+      rb_define_method(rb_cDoubleArray, "build", RUBY_METHOD_FUNC(_double_array_build), -1);
+      rb_define_method(rb_cDoubleArray, "open", RUBY_METHOD_FUNC(_double_array_open), -1);
+      rb_define_method(rb_cDoubleArray, "save", RUBY_METHOD_FUNC(_double_array_save), -1);
+      rb_define_method(rb_cDoubleArray, "exact_match_search", RUBY_METHOD_FUNC(_double_array_exact_match_search), -1);
+      rb_define_method(rb_cDoubleArray, "common_prefix_search", RUBY_METHOD_FUNC(_double_array_common_prefix_search), -1);
+      rb_define_method(rb_cDoubleArray, "traverse", RUBY_METHOD_FUNC(_double_array_traverse), -1);
+      rb_define_method(rb_cDoubleArray, "unit_size", RUBY_METHOD_FUNC(_double_array_unit_size), 0);
+      rb_define_method(rb_cDoubleArray, "size", RUBY_METHOD_FUNC(_double_array_size), 0);
+      rb_define_method(rb_cDoubleArray, "total_size", RUBY_METHOD_FUNC(_double_array_total_size), 0);
+      rb_define_method(rb_cDoubleArray, "clear", RUBY_METHOD_FUNC(_double_array_clear), 0);
+      return rb_cDoubleArray;
+    };
+
+  private:
+    static VALUE _double_array_init(VALUE self) {
+      Darts::DoubleArray* ptr = get_double_array(self);
+      new (ptr) Darts::DoubleArray();
+      return Qnil;
+    };
+
+    static VALUE _double_array_build(int argc, VALUE* argv, VALUE self) {
+      VALUE _keys = Qnil;
+      VALUE kwargs = Qnil;
+      rb_scan_args(argc, argv, "1:", &_keys, &kwargs);
+
+      ID kwtable[1] = { rb_intern("values") };
+      VALUE kwvalues[1] = { Qundef };
+      rb_get_kwargs(kwargs, kwtable, 0, 1, kwvalues);
+      VALUE _values = kwvalues[0];
+
+      const int n_keys = RARRAY_LEN(_keys);
+      char** keys = (char**)ruby_xmalloc(n_keys * sizeof(char*));
+      int* values = _values == Qundef ? NULL : (int*)ruby_xmalloc(n_keys * sizeof(int));
+      for (int i = 0; i < n_keys; i++) {
+        VALUE key_str = rb_ary_entry(_keys, i);
+        keys[i] = StringValueCStr(key_str);
+        if (_values != Qundef) values[i] = NUM2INT(rb_ary_entry(_values, i));
+      }
+
+      try {
+        get_double_array(self)->build(n_keys, keys, NULL, values);
+      } catch (Darts::Details::Exception e) {
+        ruby_xfree(keys);
+        if (_values != Qundef) ruby_xfree(values);
+        rb_raise(rb_eRuntimeError, "%s", e.what());
+        return Qfalse;
+      }
+      ruby_xfree(keys);
+      if (_values != Qundef) ruby_xfree(values);
+      return Qtrue;
+    }
+
+    static VALUE _double_array_open(int argc, VALUE* argv, VALUE self) {
+      VALUE _filename = Qnil;
+      VALUE kwargs = Qnil;
+      rb_scan_args(argc, argv, "1:", &_filename, &kwargs);
+
+      ID kwtable[3] = { rb_intern("mode"), rb_intern("offset"), rb_intern("size") };
+      VALUE kwvalues[3] = { Qundef, Qundef, Qundef };
+      rb_get_kwargs(kwargs, kwtable, 0, 3, kwvalues);
+
+      const char* filename = StringValueCStr(_filename);
+      const char* mode = kwvalues[0] == Qundef ? "rb" : StringValueCStr(kwvalues[0]);
+      const size_t offset = kwvalues[1] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[1]);
+      const size_t size = kwvalues[2] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[2]);
+
+      if (get_double_array(self)->open(filename, mode, offset, size) != 0) {
+        return Qfalse;
+      }
+      return Qtrue;
+    };
+
+    static VALUE _double_array_save(int argc, VALUE* argv, VALUE self) {
+      VALUE _filename = Qnil;
+      VALUE kwargs = Qnil;
+      rb_scan_args(argc, argv, "1:", &_filename, &kwargs);
+
+      ID kwtable[2] = { rb_intern("mode"), rb_intern("offset") };
+      VALUE kwvalues[2] = { Qundef, Qundef };
+      rb_get_kwargs(kwargs, kwtable, 0, 2, kwvalues);
+
+      const char* filename = StringValueCStr(_filename);
+      const char* mode = kwvalues[0] == Qundef ? "wb" : StringValueCStr(kwvalues[0]);
+      const size_t offset = kwvalues[1] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[1]);
+
+      if (get_double_array(self)->save(filename, mode, offset) != 0) {
+        return Qfalse;
+      }
+      return Qtrue;
+    };
+
+    static VALUE _double_array_exact_match_search(int argc, VALUE* argv, VALUE self) {
+      VALUE _key = Qnil;
+      VALUE kwargs = Qnil;
+      rb_scan_args(argc, argv, "1:", &_key, &kwargs);
+
+      ID kwtable[2] = { rb_intern("length"), rb_intern("node_pos") };
+      VALUE kwvalues[2] = { Qundef, Qundef };
+      rb_get_kwargs(kwargs, kwtable, 0, 2, kwvalues);
+
+      if (get_double_array(self)->array() == NULL) {
+        rb_raise(rb_eRuntimeError, "failed to search: dictionary is empty");
+        return Qnil;
+      }
+
+      const char* key = StringValueCStr(_key);
+      const size_t length = kwvalues[0] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[0]);
+      const size_t node_pos = kwvalues[1] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[1]);
+
+      Darts::DoubleArray::value_type value;
+      get_double_array(self)->exactMatchSearch(key, value, length, node_pos);
+      return INT2NUM(value);
+    };
+
+    static VALUE _double_array_common_prefix_search(int argc, VALUE* argv, VALUE self) {
+      VALUE _key = Qnil;
+      VALUE kwargs = Qnil;
+      rb_scan_args(argc, argv, "1:", &_key, &kwargs);
+
+      ID kwtable[3] = { rb_intern("max_num_results"), rb_intern("length"), rb_intern("node_pos") };
+      VALUE kwvalues[3] = { Qundef, Qundef, Qundef };
+      rb_get_kwargs(kwargs, kwtable, 0, 3, kwvalues);
+
+      if (get_double_array(self)->array() == NULL) {
+        rb_raise(rb_eRuntimeError, "failed to search: dictionary is empty");
+        return Qnil;
+      }
+
+      const char* key = StringValueCStr(_key);
+      const size_t max_num_results = kwvalues[0] == Qundef ? (size_t)NUM2INT(rb_funcall(_key, rb_intern("size"), 0)) : (size_t)NUM2INT(kwvalues[0]);
+      const size_t length = kwvalues[1] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[1]);
+      const size_t node_pos = kwvalues[2] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[2]);
+
+      Darts::DoubleArray::result_pair_type* results =
+        (Darts::DoubleArray::result_pair_type*)ruby_xmalloc(max_num_results * sizeof(Darts::DoubleArray::result_pair_type));
+      const size_t num_matches = get_double_array(self)->commonPrefixSearch(key, results, max_num_results, length, node_pos);
+      const int num_returns = (int)(max_num_results < num_matches ? max_num_results : num_matches);
+
+      VALUE ret = rb_ary_new();
+      if (num_returns > 0) {
+        VALUE keyenc = rb_funcall(_key, rb_intern("encoding"), 0);
+        VALUE lengths = rb_ary_new2(num_returns);
+        VALUE values = rb_ary_new2(num_returns);
+        for (int i = 0; i < num_returns; i++) {
+          rb_ary_store(lengths, i, rb_funcall(rb_str_new(key, results[i].length), rb_intern("force_encoding"), 1, keyenc));
+          rb_ary_store(values, i, INT2NUM(results[i].value));
+        }
+        rb_ary_push(ret, lengths);
+        rb_ary_push(ret, values);
+      }
+      ruby_xfree(results);
+      return ret;
+    };
+
+    static VALUE _double_array_traverse(int argc, VALUE* argv, VALUE self) {
+      VALUE _key = Qnil;
+      VALUE kwargs = Qnil;
+      rb_scan_args(argc, argv, "1:", &_key, &kwargs);
+
+      ID kwtable[3] = {  rb_intern("node_pos"), rb_intern("key_pos"), rb_intern("length") };
+      VALUE kwvalues[3] = { Qundef, Qundef, Qundef };
+      rb_get_kwargs(kwargs, kwtable, 2, 1, kwvalues);
+
+      const char* key = StringValueCStr(_key);
+      size_t node_pos = (size_t)NUM2INT(kwvalues[0]);
+      size_t key_pos = (size_t)NUM2INT(kwvalues[1]);
+      const size_t length = kwvalues[2] == Qundef ? 0 : (size_t)NUM2INT(kwvalues[2]);
+
+      Darts::DoubleArray::value_type value = get_double_array(self)->traverse(key, node_pos, key_pos, length);
+
+      VALUE ret = rb_hash_new();
+      rb_hash_aset(ret, ID2SYM(rb_intern("value")), INT2NUM(value));
+      rb_hash_aset(ret, ID2SYM(rb_intern("node_pos")), INT2NUM((int)node_pos));
+      rb_hash_aset(ret, ID2SYM(rb_intern("key_pos")), INT2NUM((int)key_pos));
+      return ret;
+    };
+
+    static VALUE _double_array_unit_size(VALUE self) {
+      return INT2NUM((int)(get_double_array(self)->unit_size()));
+    };
+
+    static VALUE _double_array_size(VALUE self) {
+      return INT2NUM((int)(get_double_array(self)->size()));
+    };
+
+    static VALUE _double_array_total_size(VALUE self) {
+      return INT2NUM((int)(get_double_array(self)->total_size()));
+    };
+
+    static VALUE _double_array_nonzero_size(VALUE self) {
+      return INT2NUM((int)(get_double_array(self)->nonzero_size()));
+    };
+
+    static VALUE _double_array_clear(VALUE self) {
+      get_double_array(self)->clear();
+      return Qnil;
+    };
+};
+
+#endif /* DARTSCLONEEXT_HPP */