osqp 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81100b0a27916edf758ca568e9213b8ea451c1efa664f00ddb84155c1c50f650
-  data.tar.gz: af59920235f7c6c4c1f13ab61861fbbb4f27bf2aebbbab59cb9a3beaef6c2099
+  metadata.gz: a723c2590dd5dea89dd98525009db82f6e3bf740e7a47032a822e23bab790eb0
+  data.tar.gz: 4515ead926d38e72843c8193ec67f072d24189108ddcc538ad0c021ccae4c35c
 SHA512:
-  metadata.gz: b480edb450da31e0ef2714452db49caa36e0089b61fbcd8b89e0a92bba0cd2a81c3442cca7fa84e0f1947dfc7f36e50fe3b1dd773f42fe80203584be2ce6fb12
-  data.tar.gz: ac74d1ec489c286618ebe8d10f1f1bf4ca4408966972e8ecbfbf8f80c918a42abdb9eb780dfbcac8dbc8016a8909727e82c53dc68c9b3c9da31564d16bd19405
+  metadata.gz: ac250fdfa3927134aff7d609456382d3bd9d79e1252e42a2adeba7d79e33db4361c504aa06701bea0cf0fa7d92a843726115af0fcba93734cb619af0883b1068
+  data.tar.gz: 84a1e39d8bbd810e49a0c2ab5dafd897208d87476dbfede8a292482cd74ee078d2e88b11424100b8ae72c6bdfb6c7dc76301ae5d40f513e575d6dea1bb4d851e

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.2.0 (2022-06-12)
+
+- Added ARM shared library for Linux
+- Fixed issue with infinite bounds
+- Dropped support for Ruby < 2.7
+
+## 0.1.3 (2022-04-08)
+
+- Improved ARM detection
+- Fixed `x` and `y` in solution
+- Fixed memory issue
+
+## 0.1.2 (2021-01-05)
+
+- Added ARM shared library for Mac
+- Updated OSQP to 0.6.2
+
 ## 0.1.1 (2020-04-10)
 
 - Changed to Apache 2.0 license to match OSQP

data/NOTICE.txt

@@ -1,4 +1,18 @@
-Copyright 2019-2020 Andrew Kane
+Copyright (c) 2019-2020 Andrew Kane
+
+OSQP
+Copyright (c) 2019 Bartolomeo Stellato, Goran Banjac, Paul Goulart, Stephen Boyd
+
+This product includes software developed at Stanford University and at the University of Oxford.
+
+
+The following external modules are included in this software library
+
+QDLDL
+Copyright (c) 2018, Paul Goulart, Bartolomeo Stellato, Goran Banjac.
+
+AMD
+Copyright (c) 1996-2015, Timothy A. Davis, Patrick R. Amestoy, and Iain S. Duff.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,15 +1,15 @@
-# OSQP
+# OSQP Ruby
 
 The [OSQP](https://osqp.org/) (Operator Splitting Quadratic Program) solver for Ruby
 
-[![Build Status](https://travis-ci.org/ankane/osqp.svg?branch=master)](https://travis-ci.org/ankane/osqp) [![Build status](https://ci.appveyor.com/api/projects/status/o93q4b56anxmnvwn/branch/master?svg=true)](https://ci.appveyor.com/project/ankane/osqp/branch/master)
+[![Build Status](https://github.com/ankane/osqp-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/osqp-ruby/actions)
 
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'osqp'
+gem "osqp"
 ```
 
 ## Getting Started
@@ -47,10 +47,10 @@ Arrays and matrices can be Ruby arrays
 [[1, 2, 3], [4, 5, 6]]
 ```
 
-Or a Numo NArrays
+Or Numo arrays
 
 ```ruby
-Numo::DFloat.new(3, 2).seq
+Numo::NArray.cast([[1, 2, 3], [4, 5, 6]])
 ```
 
 ## Resources
@@ -65,22 +65,23 @@ This library is modeled after the OSQP [Python API](https://osqp.org/docs/interf
 
 ## History
 
-View the [changelog](https://github.com/ankane/osqp/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/osqp-ruby/blob/master/CHANGELOG.md)
 
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
 
-- [Report bugs](https://github.com/ankane/osqp/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/osqp/pulls)
+- [Report bugs](https://github.com/ankane/osqp-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/osqp-ruby/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
 To get started with development:
 
 ```sh
-git clone https://github.com/ankane/osqp.git
-cd osqp
+git clone https://github.com/ankane/osqp-ruby.git
+cd osqp-ruby
 bundle install
+bundle exec rake vendor:all
 bundle exec rake test
 ```

data/lib/osqp/ffi.rb

@@ -2,21 +2,20 @@ module OSQP
   module FFI
     extend Fiddle::Importer
 
-    lib =
-      if Gem.win_platform?
-        "libosqp.dll"
-      elsif RbConfig::CONFIG["host_os"] =~ /darwin/i
-        "libosqp.dylib"
-      else
-        "libosqp.so"
-      end
-
-    dlload File.expand_path("../../vendor/#{lib}", __dir__)
+    libs = Array(OSQP.ffi_lib).dup
+    begin
+      dlload Fiddle.dlopen(libs.shift)
+    rescue Fiddle::DLError => e
+      retry if libs.any?
+      raise e
+    end
 
     typealias "c_float", "double"
     typealias "c_int", "long long"
     typealias "enum", "int"
 
+    OSQP_INFTY = 1e30
+
     Data = struct [
       "c_int n",
       "c_int m",
@@ -69,6 +68,11 @@ module OSQP
       "c_float rho_estimate"
     ]
 
+    Solution = struct [
+      "c_float *x",
+      "c_float *y"
+    ]
+
     Workspace = struct [
       "OSQPData *data",
       "LinSysSolver *linsys_solver",

data/lib/osqp/solver.rb

@@ -4,16 +4,27 @@ module OSQP
       # settings
       set = create_settings(settings)
 
+      # ensure bounds within OSQP infinity
+      l = l.map { |v| v < -FFI::OSQP_INFTY ? -FFI::OSQP_INFTY : v }
+      u = u.map { |v| v > FFI::OSQP_INFTY ? FFI::OSQP_INFTY : v }
+
       # data
+      # do not assign directly to struct to keep refs
       m, n = shape(a)
+      p = csc_matrix(p, upper: true)
+      q = float_array(q)
+      a = csc_matrix(a)
+      l = float_array(l)
+      u = float_array(u)
+
       data = FFI::Data.malloc
       data.n = n
       data.m = m
-      data.p = csc_matrix(p, upper: true)
-      data.q = float_array(q)
-      data.a = csc_matrix(a)
-      data.l = float_array(l)
-      data.u = float_array(u)
+      data.p = p
+      data.q = q
+      data.a = a
+      data.l = l
+      data.u = u
 
       # work
       work = FFI::Workspace.malloc
@@ -26,10 +37,11 @@ module OSQP
 
       check_result FFI.osqp_solve(@work)
 
-      # data
+      # solution
+      solution = FFI::Solution.new(@work.solution)
       data = FFI::Data.new(@work.data)
-      x = read_float_array(@work.x, data.n)
-      y = read_float_array(@work.y, data.m)
+      x = read_float_array(solution.x, data.n)
+      y = read_float_array(solution.y, data.m)
 
       # info
       info = FFI::Info.new(@work.info)
@@ -151,7 +163,10 @@ module OSQP
       ci = int_array(ci)
       cp = int_array(cp)
 
-      FFI.csc_matrix(m, n, nnz, cx, ci, cp)
+      ptr = FFI.csc_matrix(m, n, nnz, cx, ci, cp)
+      # save refs
+      ptr.instance_variable_set(:@osqp_refs, [cx, ci, cp])
+      ptr
     end
 
     def dimensions

data/lib/osqp/version.rb

@@ -1,3 +1,3 @@
 module OSQP
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/osqp.rb

@@ -8,10 +8,32 @@ require "osqp/version"
 module OSQP
   class Error < StandardError; end
 
-  def self.lib_version
-    FFI.osqp_version.to_s
+  class << self
+    attr_accessor :ffi_lib
   end
+  lib_path =
+    if Gem.win_platform?
+      "x64-mingw/osqp.dll"
+    elsif RbConfig::CONFIG["host_os"] =~ /darwin/i
+      if RbConfig::CONFIG["host_cpu"] =~ /arm|aarch64/i
+        "arm64-darwin/libosqp.dylib"
+      else
+        "x86_64-darwin/libosqp.dylib"
+      end
+    else
+      if RbConfig::CONFIG["host_cpu"] =~ /arm|aarch64/i
+        "aarch64-linux/libosqp.so"
+      else
+        "x86_64-linux/libosqp.so"
+      end
+    end
+  vendor_lib = File.expand_path("../vendor/#{lib_path}", __dir__)
+  self.ffi_lib = [vendor_lib]
 
   # friendlier error message
   autoload :FFI, "osqp/ffi"
+
+  def self.lib_version
+    FFI.osqp_version.to_s
+  end
 end

data/vendor/aarch64-linux/LICENSE-amd.txt

@@ -0,0 +1,36 @@
+AMD, Copyright (c), 1996-2015, Timothy A. Davis,
+Patrick R. Amestoy, and Iain S. Duff.  All Rights Reserved.
+
+Availability:
+
+    http://www.suitesparse.com
+
+-------------------------------------------------------------------------------
+AMD License: BSD 3-clause:
+-------------------------------------------------------------------------------
+
+    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 organizations to which the authors are
+          affiliated, 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 HOLDERS 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/vendor/{LICENSE → aarch64-linux/LICENSE-osqp.txt}

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2019 Bartolomeo Stellato, Goran Banjac, Paul Goulart, Stephen Boyd
+   Copyright 2021 Bartolomeo Stellato, Goran Banjac, Paul Goulart, Stephen Boyd
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/vendor/aarch64-linux/LICENSE-qdldl.txt

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

data/vendor/arm64-darwin/LICENSE-amd.txt

@@ -0,0 +1,36 @@
+AMD, Copyright (c), 1996-2015, Timothy A. Davis,
+Patrick R. Amestoy, and Iain S. Duff.  All Rights Reserved.
+
+Availability:
+
+    http://www.suitesparse.com
+
+-------------------------------------------------------------------------------
+AMD License: BSD 3-clause:
+-------------------------------------------------------------------------------
+
+    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 organizations to which the authors are
+          affiliated, 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 HOLDERS 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.
+
+