numo-optimize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f81cd59ec9e2ae660daef989ae28a5e5a075063897598e39a1457e5d5107037
+  data.tar.gz: 304c618243188c812c8a37a9d7060bf40526c8bce3f306f21f3a75cdfb917532
+SHA512:
+  metadata.gz: 64f1624de1f310cbb58fc390f0108e94dfbfcfd714c6f1c1a012af626bb96bf7da713470bfe076b1b0bf64a7016e5925801e6eb2e5ea014bb669ae16ab5b952d
+  data.tar.gz: 373769fc7093dc7b429f296a5f4b2361489cede752618ec6c280a612bf13c64bca2fb9d4dd027c0b147a9691f032d41ccb7c498782e850986ec8c485de1233ed

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2025-10-01
+
+- First release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2025 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.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+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,77 @@
+# Numo::Optimize
+
+[![Build Status](https://github.com/yoshoku/numo-optimize/actions/workflows/main.yml/badge.svg)](https://github.com/yoshoku/numo-optimize/actions/workflows/main.yml)
+[![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/numo-optimize/blob/main/LICENSE.txt)
+
+Numo::Optimize (numo-optimize) provides functions for minimizing objective functions.
+This gem is based on [Lbfgsb.rb](https://github.com/yoshoku/lbfgsb.rb) and
+[mopti](https://github.com/yoshoku/mopti) by the same author.
+As for optimization algorithms, only L-BFGS-B is currently supported.
+
+Please note that numo-optimize depends on [numo-narray-alt](https://github.com/yoshoku/numo-narray-alt), not Numo::NArray.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add numo-optimize
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install numo-optimize
+```
+
+## Usage
+
+example.rb:
+
+```ruby
+require 'numo/narray'
+require 'numo/optimize'
+
+# Define the objective function.
+obj_func = proc do |x|
+  (x - 3)**2 + 2
+end
+
+# Define the gradient (Jacobian) of the objective function.
+gradient_func = proc do |x|
+  2 * (x - 3)
+end
+
+# Initial guess
+x_init = Numo::DFloat[0.0]
+
+# Perform optimization
+result = Numo::Optimize.minimize(x_init: x_init, fnc: obj_func, jcb: gradient_func)
+
+# Output the result
+puts "Optimized parameters: #{result[:x][0]}"
+```
+
+```sh
+$ ruby example.rb
+Optimized parameters: 3.0
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/numo-optimize.
+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/numo-optimize/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause).
+In addition, L-BFGS-B carries the following condition for use:
+
+This software is freely available, but we expect that all publications describing  work using this software ,
+or all commercial products using it, quote at least one of the references given below.
+This software is released under the "New BSD License" (aka "Modified BSD License" or "3-clause license").
+
+## Code of Conduct
+
+Everyone interacting in the Numo::Optimize project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/numo-optimize/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+if ENV['BUNDLE_WITH'] == 'memcheck'
+  require 'ruby_memcheck'
+  require 'rake/testtask'
+  test_config = lambda do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/test_*.rb']
+  end
+  Rake::TestTask.new(test: :compile, &test_config)
+  namespace :test do
+    RubyMemcheck::TestTask.new(valgrind: :compile, &test_config)
+  end
+else
+  require 'minitest/test_task'
+  Minitest::TestTask.create
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+require 'rake/extensiontask'
+
+task build: :compile # rubocop:disable Rake/Desc
+
+GEMSPEC = Gem::Specification.load('numo-optimize.gemspec')
+
+Rake::ExtensionTask.new('numo/optimize', GEMSPEC) do |ext|
+  ext.lib_dir = 'lib/numo/optimize'
+end
+
+task default: %i[clobber compile test]

data/ext/numo/optimize/extconf.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+require 'numo/narray'
+
+$LOAD_PATH.each do |lp|
+  if File.exist?(File.join(lp, 'numo/numo/narray.h'))
+    $INCFLAGS = "-I#{lp}/numo #{$INCFLAGS}"
+    break
+  end
+end
+
+abort 'numo/narray.h not found.' unless have_header('numo/narray.h')
+
+if RUBY_PLATFORM.match?(/mswin|cygwin|mingw/)
+  $LOAD_PATH.each do |lp|
+    if File.exist?(File.join(lp, 'numo/libnarray.a'))
+      $LDFLAGS = "-L#{lp}/numo #{$LDFLAGS}"
+      break
+    end
+  end
+  abort 'libnarray.a not found.' unless have_library('narray', 'nary_new')
+end
+
+$defs << '-DUSE_INT64' if with_config('use-int64', false)
+
+$srcs = Dir.glob("#{$srcdir}/**/*.c").map { |path| File.basename(path) }
+
+blas_dir = with_config('blas-dir')
+$LDFLAGS = "-L#{blas_dir} #{$LDFLAGS}" unless blas_dir.nil?
+
+blas_lib = with_config('blas-lib')
+unless blas_lib.nil?
+  abort "#{blas_lib} not found." unless have_library(blas_lib)
+  $srcs.delete('blas.c')
+end
+
+$VPATH << '$(srcdir)/src'
+
+# Makes all symbols private by default to avoid unintended conflict
+# with other gems. To explicitly export symbols you can use RUBY_FUNC_EXPORTED
+# selectively, or entirely remove this flag.
+append_cflags('-fvisibility=hidden')
+
+create_makefile('numo/optimize/optimize')

data/ext/numo/optimize/optimize.c

@@ -0,0 +1,228 @@
+#include "optimize.h"
+
+VALUE rb_mOptimize;
+VALUE rb_mLbfgsb;
+
+static VALUE lbfgsb_fmin(VALUE self, VALUE fnc, VALUE x_val, VALUE jcb, VALUE args, VALUE l_val, VALUE u_val,
+                         VALUE nbd_val, VALUE maxcor, VALUE ftol, VALUE gtol, VALUE maxiter, VALUE disp) {
+  F77_int n_iter;
+  F77_int n_fev;
+  F77_int n_jev;
+#ifdef USE_INT64
+  F77_int max_iter = NUM2LONG(maxiter);
+#else
+  F77_int max_iter = NUM2INT(maxiter);
+#endif
+  narray_t* x_nary;
+  narray_t* l_nary;
+  narray_t* u_nary;
+  narray_t* nbd_nary;
+  F77_int n;
+#ifdef USE_INT64
+  F77_int m = NUM2LONG(maxcor);
+#else
+  F77_int m = NUM2INT(maxcor);
+#endif
+  double* x_ptr;
+  double* l_ptr;
+  double* u_ptr;
+  F77_int* nbd_ptr;
+  double f;
+  double* g;
+  double factr = NUM2DBL(ftol);
+  double pgtol = NUM2DBL(gtol);
+  double* wa;
+  F77_int* iwa;
+  char task[60];
+#ifdef USE_INT64
+  F77_int iprint = NIL_P(disp) ? -1 : NUM2LONG(disp);
+#else
+  F77_int iprint = NIL_P(disp) ? -1 : NUM2INT(disp);
+#endif
+  char csave[60];
+  F77_int lsave[4];
+  F77_int isave[44];
+  double dsave[29];
+  VALUE g_val;
+  VALUE fg_arr;
+  VALUE ret;
+
+  GetNArray(x_val, x_nary);
+  if (NA_NDIM(x_nary) != 1) {
+    rb_raise(rb_eArgError, "x must be a 1-D array.");
+    return Qnil;
+  }
+  n = (F77_int)NA_SIZE(x_nary);
+  if (CLASS_OF(x_val) != numo_cDFloat) {
+    x_val = rb_funcall(numo_cDFloat, rb_intern("cast"), 1, x_val);
+  }
+  if (!RTEST(nary_check_contiguous(x_val))) {
+    x_val = nary_dup(x_val);
+  }
+
+  GetNArray(l_val, l_nary);
+  if (NA_NDIM(l_nary) != 1) {
+    rb_raise(rb_eArgError, "l must be a 1-D array.");
+    return Qnil;
+  }
+  if ((F77_int)NA_SIZE(l_nary) != n) {
+    rb_raise(rb_eArgError, "The size of l must be equal to that of x.");
+    return Qnil;
+  }
+  if (CLASS_OF(l_val) != numo_cDFloat) {
+    l_val = rb_funcall(numo_cDFloat, rb_intern("cast"), 1, l_val);
+  }
+  if (!RTEST(nary_check_contiguous(l_val))) {
+    l_val = nary_dup(l_val);
+  }
+
+  GetNArray(u_val, u_nary);
+  if (NA_NDIM(u_nary) != 1) {
+    rb_raise(rb_eArgError, "u must be a 1-D array.");
+    return Qnil;
+  }
+  if ((F77_int)NA_SIZE(u_nary) != n) {
+    rb_raise(rb_eArgError, "The size of u must be equal to that of x.");
+    return Qnil;
+  }
+  if (CLASS_OF(u_val) != numo_cDFloat) {
+    u_val = rb_funcall(numo_cDFloat, rb_intern("cast"), 1, u_val);
+  }
+  if (!RTEST(nary_check_contiguous(u_val))) {
+    u_val = nary_dup(u_val);
+  }
+
+  GetNArray(nbd_val, nbd_nary);
+  if (NA_NDIM(nbd_nary) != 1) {
+    rb_raise(rb_eArgError, "nbd must be a 1-D array.");
+    return Qnil;
+  }
+  if ((F77_int)NA_SIZE(nbd_nary) != n) {
+    rb_raise(rb_eArgError, "The size of nbd must be equal to that of x.");
+    return Qnil;
+  }
+#ifdef USE_INT64
+  if (CLASS_OF(nbd_val) != numo_cInt64) {
+    nbd_val = rb_funcall(numo_cInt64, rb_intern("cast"), 1, nbd_val);
+  }
+#else
+  if (CLASS_OF(nbd_val) != numo_cInt32) {
+    nbd_val = rb_funcall(numo_cInt32, rb_intern("cast"), 1, nbd_val);
+  }
+#endif
+  if (!RTEST(nary_check_contiguous(nbd_val))) {
+    nbd_val = nary_dup(nbd_val);
+  }
+
+  x_ptr = (double*)na_get_pointer_for_read_write(x_val);
+  l_ptr = (double*)na_get_pointer_for_read(l_val);
+  u_ptr = (double*)na_get_pointer_for_read(u_val);
+  nbd_ptr = (F77_int*)na_get_pointer_for_read(nbd_val);
+  g = ALLOC_N(double, n);
+  wa = ALLOC_N(double, (2 * m + 5) * n + 12 * m * m + 12 * m);
+  iwa = ALLOC_N(F77_int, 3 * n);
+
+  g_val = Qnil;
+  f = 0.0;
+  memset(g, 0, n * sizeof(*g));
+  strcpy(task, "START");
+  n_fev = 0;
+  n_jev = 0;
+
+  for (n_iter = 0; n_iter < max_iter;) {
+    setulb_(&n, &m, x_ptr, l_ptr, u_ptr, nbd_ptr, &f, g, &factr, &pgtol, wa, iwa, task, &iprint, csave, lsave, isave, dsave);
+    if (strncmp(task, "FG", 2) == 0) {
+      if (RB_TYPE_P(jcb, T_TRUE)) {
+        fg_arr = rb_funcall(self, rb_intern("fnc"), 3, fnc, x_val, args);
+        f = NUM2DBL(rb_ary_entry(fg_arr, 0));
+        g_val = rb_ary_entry(fg_arr, 1);
+      } else {
+        f = NUM2DBL(rb_funcall(self, rb_intern("fnc"), 3, fnc, x_val, args));
+        g_val = rb_funcall(self, rb_intern("jcb"), 3, jcb, x_val, args);
+      }
+      n_fev++;
+      n_jev++;
+      if (CLASS_OF(g_val) != numo_cDFloat)
+        g_val = rb_funcall(numo_cDFloat, rb_intern("cast"), 1, g_val);
+      if (!RTEST(nary_check_contiguous(g_val)))
+        g_val = nary_dup(g_val);
+      memcpy(g, na_get_pointer_for_read(g_val), n * sizeof(*g));
+      RB_GC_GUARD(g_val);
+    } else if (strncmp(task, "NEW_X", 5) == 0) {
+      n_iter++;
+    } else {
+      break;
+    }
+  }
+
+  xfree(g);
+  xfree(wa);
+  xfree(iwa);
+
+  ret = rb_hash_new();
+  rb_hash_aset(ret, ID2SYM(rb_intern("task")), rb_str_new_cstr(task));
+  rb_hash_aset(ret, ID2SYM(rb_intern("x")), x_val);
+  rb_hash_aset(ret, ID2SYM(rb_intern("fnc")), DBL2NUM(f));
+  rb_hash_aset(ret, ID2SYM(rb_intern("jcb")), g_val);
+#ifdef USE_INT64
+  rb_hash_aset(ret, ID2SYM(rb_intern("n_iter")), LONG2NUM(n_iter));
+  rb_hash_aset(ret, ID2SYM(rb_intern("n_fev")), LONG2NUM(n_fev));
+  rb_hash_aset(ret, ID2SYM(rb_intern("n_jev")), LONG2NUM(n_jev));
+#else
+  rb_hash_aset(ret, ID2SYM(rb_intern("n_iter")), INT2NUM(n_iter));
+  rb_hash_aset(ret, ID2SYM(rb_intern("n_fev")), INT2NUM(n_fev));
+  rb_hash_aset(ret, ID2SYM(rb_intern("n_jev")), INT2NUM(n_jev));
+#endif
+  rb_hash_aset(ret, ID2SYM(rb_intern("success")), strncmp(task, "CONV", 4) == 0 ? Qtrue : Qfalse);
+
+  RB_GC_GUARD(x_val);
+  RB_GC_GUARD(l_val);
+  RB_GC_GUARD(u_val);
+  RB_GC_GUARD(nbd_val);
+
+  return ret;
+}
+
+RUBY_FUNC_EXPORTED void
+Init_optimize(void) {
+  rb_require("numo/narray");
+
+  /**
+   * Document-module: Numo::Optimize
+   */
+  rb_mOptimize = rb_define_module_under(rb_mNumo, "Optimize");
+  /**
+   * Document-module: Numo::Optimize::Lbfgsb
+   */
+  rb_mLbfgsb = rb_define_module_under(rb_mOptimize, "Lbfgsb");
+
+#ifdef USE_INT64
+  /* The bit size of fortran integer. */
+  rb_define_const(rb_mLbfgsb, "SZ_F77_INTEGER", INT2NUM(64));
+#else
+  /* The bit size of fortran integer. */
+  rb_define_const(rb_mLbfgsb, "SZ_F77_INTEGER", INT2NUM(32));
+#endif
+  /* The value of double epsilon used in the native extension. */
+  rb_define_const(rb_mLbfgsb, "DBL_EPSILON", DBL2NUM(DBL_EPSILON));
+  /**
+   * Minimize a function using the L-BFGS-B algorithm.
+   * This module function is for internal use. It is recommended to use `Numo::Optimize.minimize`.
+   *
+   * @overload fmin(fnc, x, jcb, args, l, u, nbd, maxcor, ftol, gtol, maxiter, disp)
+   *   @param fnc [Method/Proc]
+   *   @param x [Numo::DFloat]
+   *   @param jcb [Method/Proc/boolean]
+   *   @param args [Object]
+   *   @param l [Numo::DFloat]
+   *   @param u [Numo::DFloat]
+   *   @param nbd [Numo::Int32/Numo::Int64]
+   *   @param maxcor [Integer]
+   *   @param ftol [Float]
+   *   @param gtol [Float]
+   *   @param maxiter [Integer]
+   *   @param disp [Integer/nil]
+   *   @return [Hash{Symbol => Object}]
+   */
+  rb_define_module_function(rb_mLbfgsb, "fmin", lbfgsb_fmin, 12);
+}

data/ext/numo/optimize/optimize.h

@@ -0,0 +1,13 @@
+#ifndef NUMO_OPTIMIZE_H
+#define NUMO_OPTIMIZE_H 1
+
+#include <float.h>
+
+#include <ruby.h>
+
+#include <numo/narray.h>
+#include <numo/template.h>
+
+#include "src/lbfgsb.h"
+
+#endif /* NUMO_OPTIMIZE_H */

data/ext/numo/optimize/src/License.txt

@@ -0,0 +1,71 @@
+3-clause license ("New BSD License" or "Modified BSD License")
+New BSD License
+Author	Regents of the University of California
+Publisher	Public Domain
+Published	July 22, 1999[8]
+DFSG compatible	Yes[7]
+FSF approved	Yes[1]
+OSI approved	Yes[3]
+GPL compatible	Yes[1]
+Copyleft	No[1]
+Copyfree	Yes
+Linking from code with a different license	Yes
+
+The advertising clause was removed from the license text in the official BSD on July 22, 1999 by William Hoskins, Director of 
+the Office of Technology Licensing for UC Berkeley.[8] Other BSD distributions removed the clause, but many similar clauses 
+remain in BSD-derived code from other sources, and unrelated code using a derived license.
+
+While the original license is sometimes referred to as "BSD-old", the resulting 3-clause version is sometimes referred to by 
+"BSD-new." Other names include "New BSD", "revised BSD", "BSD-3", or "3-clause BSD". This version has been vetted as 
+an Open source license by the OSI as the "The BSD License".[3] The Free Software Foundation, which refers to the license 
+as the "Modified BSD License", states that it is compatible with the GNU GPL. The FSF encourages users to be specific 
+when referring to the license by name (i.e. not simply referring to it as "a BSD license" or "BSD-style") to avoid confusion with 
+the original BSD license.[1]
+
+This version allows unlimited redistribution for any purpose as long as its copyright notices and the license's disclaimers of 
+warranty are maintained. The license also contains a clause restricting use of the names of contributors for endorsement of a 
+derived work without specific permission.
+
+Copyright (c) <year>, <copyright holder>
+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.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+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 <COPYRIGHT HOLDER> 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.
+
+
+References
+
+1. ^ a b c d e "Various Licenses and Comments about Them - GNU Project - Free Software Foundation (FSF): Modified BSD license". 
+     Free Software Foundation. Retrieved 02 October 2010.
+2. ^ a b c d e "Various Licenses and Comments about Them - GNU Project - Free Software Foundation (FSF): FreeBSD license". 
+     Free Software Foundation. Retrieved 02 October 2010.
+3. ^ a b c d e f "Open Source Initiative OSI - The BSD License:Licensing". Open Source Initiative. Retrieved 06 December 2009.
+4. ^ a b c d "Various Licenses and Comments about Them - GNU Project - Free Software Foundation (FSF): Original BSD license". 
+     Free Software Foundation. Retrieved 02 October 2010.
+5. ^ The year given is the year 4.3BSD-Tahoe was released. Whether this is the first use of the license is not known.
+6. ^ The year given is the year 4.3BSD-Reno was released. Whether this is the first use of the license is not known.
+7. ^ a b "Debian -- License information". Debian. Retrieved 18 February 2010.
+8. ^ a b c "To All Licensees, Distributors of Any Version of BSD". University of California, Berkeley. 1999-07-22. Retrieved 
+     2006-11-15.
+9. ^ Richard Stallman. "The BSD License Problem". Free Software Foundation. Retrieved 2006-11-15.
+10. ^ "The FreeBSD Copyright". The FreeBSD Project. Retrieved 6 December 2009.
+11. ^ "NetBSD Licensing and Redistribution". The NetBSD Foundation. Retrieved 06 December 2009.