hnswlib 0.1.0

data/ext/hnswlib/hnswlibext.hpp

@@ -0,0 +1,420 @@
+/**
+ * hnswlib.rb is a Ruby binding for the Hnswlib.
+ *
+ * Copyright (c) 2021 Atsushi Tatsuma
+ *
+ * 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.
+ */
+
+#ifndef HNSWLIBEXT_HPP
+#define HNSWLIBEXT_HPP 1
+
+#include <ruby.h>
+
+#include <hnswlib.h>
+
+VALUE rb_cHnswlibL2Space;
+VALUE rb_cHnswlibInnerProductSpace;
+VALUE rb_cHnswlibHierarchicalNSW;
+
+class RbHnswlibL2Space {
+  public:
+    static VALUE hnsw_l2space_alloc(VALUE self) {
+      hnswlib::L2Space* ptr = (hnswlib::L2Space*)ruby_xmalloc(sizeof(hnswlib::L2Space));
+      return TypedData_Wrap_Struct(self, &hnsw_l2space_type, ptr);
+    };
+
+    static void hnsw_l2space_free(void* ptr) {
+      ((hnswlib::L2Space*)ptr)->~L2Space();
+      ruby_xfree(ptr);
+    };
+
+    static size_t hnsw_l2space_size(const void* ptr) {
+      return sizeof(*((hnswlib::L2Space*)ptr));
+    };
+
+    static hnswlib::L2Space* get_hnsw_l2space(VALUE self) {
+      hnswlib::L2Space* ptr;
+      TypedData_Get_Struct(self, hnswlib::L2Space, &hnsw_l2space_type, ptr);
+      return ptr;
+    };
+
+    static VALUE define_class(VALUE rb_mHnswlib) {
+      rb_cHnswlibL2Space = rb_define_class_under(rb_mHnswlib, "L2Space", rb_cObject);
+      rb_define_alloc_func(rb_cHnswlibL2Space, hnsw_l2space_alloc);
+      rb_define_method(rb_cHnswlibL2Space, "initialize", RUBY_METHOD_FUNC(_hnsw_l2space_init), 1);
+      rb_define_method(rb_cHnswlibL2Space, "distance", RUBY_METHOD_FUNC(_hnsw_l2space_distance), 2);
+      rb_define_attr(rb_cHnswlibL2Space, "dim", 1, 0);
+      return rb_cHnswlibL2Space;
+    };
+
+  private:
+    static const rb_data_type_t hnsw_l2space_type;
+
+    static VALUE _hnsw_l2space_init(VALUE self, VALUE dim) {
+      rb_iv_set(self, "@dim", dim);
+      hnswlib::L2Space* ptr = get_hnsw_l2space(self);
+      new (ptr) hnswlib::L2Space(NUM2INT(rb_iv_get(self, "@dim")));
+      return Qnil;
+    };
+
+    static VALUE _hnsw_l2space_distance(VALUE self, VALUE arr_a, VALUE arr_b) {
+      const int dim = NUM2INT(rb_iv_get(self, "@dim"));
+      if (dim != RARRAY_LEN(arr_a) || dim != RARRAY_LEN(arr_b)) {
+        rb_raise(rb_eArgError, "Array size does not match to space dimensionality.");
+        return Qnil;
+      }
+      float* vec_a = (float*)ruby_xmalloc(dim * sizeof(float));
+      for (int i = 0; i < dim; i++) {
+        vec_a[i] = (float)NUM2DBL(rb_ary_entry(arr_a, i));
+      }
+      float* vec_b = (float*)ruby_xmalloc(dim * sizeof(float));
+      for (int i = 0; i < dim; i++) {
+        vec_b[i] = (float)NUM2DBL(rb_ary_entry(arr_b, i));
+      }
+      hnswlib::DISTFUNC<float> dist_func = get_hnsw_l2space(self)->get_dist_func();
+      const float dist = dist_func(vec_a, vec_b, get_hnsw_l2space(self)->get_dist_func_param());
+      ruby_xfree(vec_a);
+      ruby_xfree(vec_b);
+      return DBL2NUM((double)dist);
+    };
+};
+
+const rb_data_type_t RbHnswlibL2Space::hnsw_l2space_type = {
+  "RbHnswlibL2Space",
+  {
+    NULL,
+    RbHnswlibL2Space::hnsw_l2space_free,
+    RbHnswlibL2Space::hnsw_l2space_size
+  },
+  NULL,
+  NULL,
+  RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+class RbHnswlibInnerProductSpace {
+  public:
+    static VALUE hnsw_ipspace_alloc(VALUE self) {
+      hnswlib::InnerProductSpace* ptr = (hnswlib::InnerProductSpace*)ruby_xmalloc(sizeof(hnswlib::InnerProductSpace));
+      return TypedData_Wrap_Struct(self, &hnsw_ipspace_type, ptr);
+    };
+
+    static void hnsw_ipspace_free(void* ptr) {
+      ((hnswlib::InnerProductSpace*)ptr)->~InnerProductSpace();
+      ruby_xfree(ptr);
+    };
+
+    static size_t hnsw_ipspace_size(const void* ptr) {
+      return sizeof(*((hnswlib::InnerProductSpace*)ptr));
+    };
+
+    static hnswlib::InnerProductSpace* get_hnsw_ipspace(VALUE self) {
+      hnswlib::InnerProductSpace* ptr;
+      TypedData_Get_Struct(self, hnswlib::InnerProductSpace, &hnsw_ipspace_type, ptr);
+      return ptr;
+    };
+
+    static VALUE define_class(VALUE rb_mHnswlib) {
+      rb_cHnswlibInnerProductSpace = rb_define_class_under(rb_mHnswlib, "InnerProductSpace", rb_cObject);
+      rb_define_alloc_func(rb_cHnswlibInnerProductSpace, hnsw_ipspace_alloc);
+      rb_define_method(rb_cHnswlibInnerProductSpace, "initialize", RUBY_METHOD_FUNC(_hnsw_ipspace_init), 1);
+      rb_define_method(rb_cHnswlibInnerProductSpace, "distance", RUBY_METHOD_FUNC(_hnsw_ipspace_distance), 2);
+      rb_define_attr(rb_cHnswlibInnerProductSpace, "dim", 1, 0);
+      return rb_cHnswlibInnerProductSpace;
+    };
+
+  private:
+    static const rb_data_type_t hnsw_ipspace_type;
+
+    static VALUE _hnsw_ipspace_init(VALUE self, VALUE dim) {
+      rb_iv_set(self, "@dim", dim);
+      hnswlib::InnerProductSpace* ptr = get_hnsw_ipspace(self);
+      new (ptr) hnswlib::InnerProductSpace(NUM2INT(rb_iv_get(self, "@dim")));
+      return Qnil;
+    };
+
+    static VALUE _hnsw_ipspace_distance(VALUE self, VALUE arr_a, VALUE arr_b) {
+      const int dim = NUM2INT(rb_iv_get(self, "@dim"));
+      if (dim != RARRAY_LEN(arr_a) || dim != RARRAY_LEN(arr_b)) {
+        rb_raise(rb_eArgError, "Array size does not match to space dimensionality.");
+        return Qnil;
+      }
+      float* vec_a = (float*)ruby_xmalloc(dim * sizeof(float));
+      for (int i = 0; i < dim; i++) {
+        vec_a[i] = (float)NUM2DBL(rb_ary_entry(arr_a, i));
+      }
+      float* vec_b = (float*)ruby_xmalloc(dim * sizeof(float));
+      for (int i = 0; i < dim; i++) {
+        vec_b[i] = (float)NUM2DBL(rb_ary_entry(arr_b, i));
+      }
+      hnswlib::DISTFUNC<float> dist_func = get_hnsw_ipspace(self)->get_dist_func();
+      const float dist = dist_func(vec_a, vec_b, get_hnsw_ipspace(self)->get_dist_func_param());
+      ruby_xfree(vec_a);
+      ruby_xfree(vec_b);
+      return DBL2NUM((double)dist);
+    };
+};
+
+const rb_data_type_t RbHnswlibInnerProductSpace::hnsw_ipspace_type = {
+  "RbHnswlibInnerProductSpace",
+  {
+    NULL,
+    RbHnswlibInnerProductSpace::hnsw_ipspace_free,
+    RbHnswlibInnerProductSpace::hnsw_ipspace_size
+  },
+  NULL,
+  NULL,
+  RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+class RbHnswlibHierarchicalNSW {
+  public:
+    static VALUE hnsw_hierarchicalnsw_alloc(VALUE self) {
+      hnswlib::HierarchicalNSW<float>* ptr = (hnswlib::HierarchicalNSW<float>*)ruby_xmalloc(sizeof(hnswlib::HierarchicalNSW<float>));
+      return TypedData_Wrap_Struct(self, &hnsw_hierarchicalnsw_type, ptr);
+    };
+
+    static void hnsw_hierarchicalnsw_free(void* ptr) {
+      ((hnswlib::HierarchicalNSW<float>*)ptr)->~HierarchicalNSW();
+      ruby_xfree(ptr);
+    };
+
+    static size_t hnsw_hierarchicalnsw_size(const void* ptr) {
+      return sizeof(*((hnswlib::HierarchicalNSW<float>*)ptr));
+    };
+
+    static hnswlib::HierarchicalNSW<float>* get_hnsw_hierarchicalnsw(VALUE self) {
+      hnswlib::HierarchicalNSW<float>* ptr;
+      TypedData_Get_Struct(self, hnswlib::HierarchicalNSW<float>, &hnsw_hierarchicalnsw_type, ptr);
+      return ptr;
+    };
+
+    static VALUE define_class(VALUE rb_mHnswlib) {
+      rb_cHnswlibHierarchicalNSW = rb_define_class_under(rb_mHnswlib, "HierarchicalNSW", rb_cObject);
+      rb_define_alloc_func(rb_cHnswlibHierarchicalNSW, hnsw_hierarchicalnsw_alloc);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "initialize", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_init), -1);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "add_point", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_add_point), 2);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "search_knn", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_search_knn), 2);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "save_index", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_save_index), 1);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "load_index", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_load_index), 1);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "get_point", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_get_point), 1);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "get_ids", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_get_ids), 0);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "mark_deleted", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_mark_deleted), 1);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "resize_index", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_resize_index), 1);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "set_ef", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_set_ef), 1);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "max_elements", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_max_elements), 0);
+      rb_define_method(rb_cHnswlibHierarchicalNSW, "current_count", RUBY_METHOD_FUNC(_hnsw_hierarchicalnsw_current_count), 0);
+      rb_define_attr(rb_cHnswlibHierarchicalNSW, "space", 1, 0);
+      return rb_cHnswlibHierarchicalNSW;
+    };
+
+  private:
+    static const rb_data_type_t hnsw_hierarchicalnsw_type;
+
+    static VALUE _hnsw_hierarchicalnsw_init(int argc, VALUE* argv, VALUE self) {
+      VALUE kw_args = Qnil;
+      ID kw_table[5] = {
+        rb_intern("space"),
+        rb_intern("max_elements"),
+        rb_intern("m"),
+        rb_intern("ef_construction"),
+        rb_intern("random_seed")
+      };
+      VALUE kw_values[5] = {
+        Qundef, Qundef, Qundef, Qundef, Qundef
+      };
+      rb_scan_args(argc, argv, ":", &kw_args);
+      rb_get_kwargs(kw_args, kw_table, 2, 3, kw_values);
+      if (kw_values[2] == Qundef) kw_values[2] = INT2NUM(16);
+      if (kw_values[3] == Qundef) kw_values[3] = INT2NUM(200);
+      if (kw_values[4] == Qundef) kw_values[4] = INT2NUM(100);
+
+      rb_iv_set(self, "@space", kw_values[0]);
+      hnswlib::SpaceInterface<float>* space;
+      if (CLASS_OF(kw_values[0]) == rb_cHnswlibL2Space) {
+        space = RbHnswlibL2Space::get_hnsw_l2space(kw_values[0]);
+      } else {
+        space = RbHnswlibInnerProductSpace::get_hnsw_ipspace(kw_values[0]);
+      }
+      const size_t max_elements = (size_t)NUM2INT(kw_values[1]);
+      const size_t m = (size_t)NUM2INT(kw_values[2]);
+      const size_t ef_construction = (size_t)NUM2INT(kw_values[3]);
+      const size_t random_seed = (size_t)NUM2INT(kw_values[4]);
+
+      hnswlib::HierarchicalNSW<float>* ptr = get_hnsw_hierarchicalnsw(self);
+      new (ptr) hnswlib::HierarchicalNSW<float>(space, max_elements, m, ef_construction, random_seed);
+
+      return Qnil;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_add_point(VALUE self, VALUE arr, VALUE idx) {
+      const int dim = NUM2INT(rb_iv_get(rb_iv_get(self, "@space"), "@dim"));
+
+      if (!RB_TYPE_P(arr, T_ARRAY)) {
+        rb_raise(rb_eArgError, "Expect point vector to be Ruby Array.");
+        return Qfalse;
+      }
+
+      if (!RB_INTEGER_TYPE_P(idx)) {
+        rb_raise(rb_eArgError, "Expect index to be Ruby Integer.");
+        return Qfalse;
+      }
+
+      if (dim != RARRAY_LEN(arr)) {
+        rb_raise(rb_eArgError, "Array size does not match to index dimensionality.");
+        return Qfalse;
+      }
+
+      float* vec = (float*)ruby_xmalloc(dim * sizeof(float));
+      for (int i = 0; i < dim; i++) {
+        vec[i] = (float)NUM2DBL(rb_ary_entry(arr, i));
+      }
+
+      get_hnsw_hierarchicalnsw(self)->addPoint((void *)vec, (size_t)NUM2INT(idx));
+
+      ruby_xfree(vec);
+      return Qtrue;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_search_knn(VALUE self, VALUE arr, VALUE k) {
+      const int dim = NUM2INT(rb_iv_get(rb_iv_get(self, "@space"), "@dim"));
+
+      if (!RB_TYPE_P(arr, T_ARRAY)) {
+        rb_raise(rb_eArgError, "Expect query vector to be Ruby Array.");
+        return Qnil;
+      }
+
+      if (!RB_INTEGER_TYPE_P(k)) {
+        rb_raise(rb_eArgError, "Expect the number of nearest neighbors to be Ruby Integer.");
+        return Qnil;
+      }
+
+      if (dim != RARRAY_LEN(arr)) {
+        rb_raise(rb_eArgError, "Array size does not match to index dimensionality.");
+        return Qnil;
+      }
+
+      float* vec = (float*)ruby_xmalloc(dim * sizeof(float));
+      for (int i = 0; i < dim; i++) {
+        vec[i] = (float)NUM2DBL(rb_ary_entry(arr, i));
+      }
+
+      std::priority_queue<std::pair<float, size_t>> result =
+        get_hnsw_hierarchicalnsw(self)->searchKnn((void *)vec, (size_t)NUM2INT(k));
+
+      ruby_xfree(vec);
+
+      if (result.size() != (size_t)NUM2INT(k)) {
+        rb_raise(rb_eRuntimeError, "Cannot return the results in a contigious 2D array. Probably ef or M is too small.");
+        return Qnil;
+      }
+
+      VALUE distances_arr = rb_ary_new2(result.size());
+      VALUE neighbors_arr = rb_ary_new2(result.size());
+
+      for (int i = NUM2INT(k) - 1; i >= 0; i--) {
+        const std::pair<float, size_t>& result_tuple = result.top();
+        rb_ary_store(distances_arr, i, DBL2NUM((double)result_tuple.first));
+        rb_ary_store(neighbors_arr, i, INT2NUM((int)result_tuple.second));
+        result.pop();
+      }
+
+      VALUE ret = rb_ary_new2(2);
+      rb_ary_store(ret, 0, neighbors_arr);
+      rb_ary_store(ret, 1, distances_arr);
+      return ret;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_save_index(VALUE self, VALUE _filename) {
+      std::string filename(StringValuePtr(_filename));
+      get_hnsw_hierarchicalnsw(self)->saveIndex(filename);
+      RB_GC_GUARD(_filename);
+      return Qnil;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_load_index(VALUE self, VALUE _filename) {
+      std::string filename(StringValuePtr(_filename));
+      hnswlib::SpaceInterface<float>* space;
+      if (CLASS_OF(rb_iv_get(self, "@space")) == rb_cHnswlibL2Space) {
+        space = RbHnswlibL2Space::get_hnsw_l2space(rb_iv_get(self, "@space"));
+      } else {
+        space = RbHnswlibInnerProductSpace::get_hnsw_ipspace(rb_iv_get(self, "@space"));
+      }
+      get_hnsw_hierarchicalnsw(self)->loadIndex(filename, space);
+      RB_GC_GUARD(_filename);
+      return Qnil;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_get_point(VALUE self, VALUE idx) {
+      VALUE ret = Qnil;
+      try {
+        std::vector<float> vec = get_hnsw_hierarchicalnsw(self)->template getDataByLabel<float>((size_t)NUM2INT(idx));
+        ret = rb_ary_new2(vec.size());
+        for (size_t i = 0; i < vec.size(); i++) {
+          rb_ary_store(ret, i, DBL2NUM((double)vec[i]));
+        }
+      } catch(std::runtime_error const& e) {
+        rb_raise(rb_eRuntimeError, "%s", e.what());
+      }
+      return ret;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_get_ids(VALUE self) {
+      VALUE ret = rb_ary_new();
+      for (auto kv : get_hnsw_hierarchicalnsw(self)->label_lookup_) {
+        rb_ary_push(ret, INT2NUM((int)kv.first));
+      }
+      return ret;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_mark_deleted(VALUE self, VALUE idx) {
+      get_hnsw_hierarchicalnsw(self)->markDelete((size_t)NUM2INT(idx));
+      return Qnil;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_resize_index(VALUE self, VALUE new_max_elements) {
+      if ((size_t)NUM2INT(new_max_elements) < get_hnsw_hierarchicalnsw(self)->cur_element_count) {
+        rb_raise(rb_eArgError, "Cannot resize, max element is less than the current number of elements.");
+        return Qnil;
+      }
+      get_hnsw_hierarchicalnsw(self)->resizeIndex((size_t)NUM2INT(new_max_elements));
+      return Qnil;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_set_ef(VALUE self, VALUE ef) {
+      get_hnsw_hierarchicalnsw(self)->ef_ = (size_t)NUM2INT(ef);
+      return Qnil;
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_max_elements(VALUE self) {
+      return INT2NUM((int)(get_hnsw_hierarchicalnsw(self)->max_elements_));
+    };
+
+    static VALUE _hnsw_hierarchicalnsw_current_count(VALUE self) {
+      return INT2NUM((int)(get_hnsw_hierarchicalnsw(self)->cur_element_count));
+    };
+};
+
+const rb_data_type_t RbHnswlibHierarchicalNSW::hnsw_hierarchicalnsw_type = {
+  "RbHnswlibHierarchicalNSW",
+  {
+    NULL,
+    RbHnswlibHierarchicalNSW::hnsw_hierarchicalnsw_free,
+    RbHnswlibHierarchicalNSW::hnsw_hierarchicalnsw_size
+  },
+  NULL,
+  NULL,
+  RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+#endif /* HNSWLIBEXT_HPP */

data/ext/hnswlib/src/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.