scs 0.2.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf0730fd042983c36ce96ea46ad28c0a330c5765e1521f8cfb28eb3321507df9
-  data.tar.gz: 677ebb1dc72dc2c1e51857c8644a11e91f9a332c95574ee8c452e31f36f4ec88
+  metadata.gz: db74c6ffd6696e799a18d2f5d02f5b753020a2535e539cdd26abac388f1ea046
+  data.tar.gz: f7d5b3b98b58d812fb923193303b7f0bfcf7cb2972de2ae34a392fb9f4a5bd40
 SHA512:
-  metadata.gz: 889d538aba521314bc093e11fc584eb58f519116f72fedcab865b9a49a44fec44eaffbc20e28d1f2673c294922474c7ccc91f7ee7f0b08243c9e20ae52150e3c
-  data.tar.gz: 25ca5f1af62a227f1f05c34031d8f1554e1b9121c2d8c43bb40c4bd12d0af5d106b73a601f8abb8a3849fbdcde310b51a2fecfe17bb9e4bba4d3a70e5fd59fff
+  metadata.gz: cf7a4948ba7a21865142a421da3e683904951faf7e602d429722cf05bdbae559dcc15484e6cb4afa6bf683ecf681757370bfa3fa7b01dab6620b300462eea703
+  data.tar.gz: 493da1d4fbe2fdb7180fffad3599137500d437b082d788365bf828dd8845469b3bf0d63863ea467c013cc2f874c5b04ab935c7129d45b1c890278dda7ad21039

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 0.3.2 (2022-01-17)
+
+- Updated SCS to 3.1.1
+
+## 0.3.1 (2021-10-08)
+
+- Fixed installation on Linux
+
+## 0.3.0 (2021-10-05)
+
+- Updated SCS to 3.0.0
+
+## 0.2.3 (2021-09-09)
+
+- Updated SCS to 2.1.4
+
 ## 0.2.2 (2020-07-21)
 
 - Updated SCS to 2.1.2

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2019-2020 Andrew Kane
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2012 Brendan O'Donoghue (bodonoghue85@gmail.com)
+Copyright (c) 2019-2021 Andrew Kane
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,17 +1,17 @@
-# SCS
+# SCS Ruby
 
 [SCS](https://github.com/cvxgrp/scs) - the splitting conic solver - for Ruby
 
 :fire: Supports many different [problem types](https://www.cvxpy.org/tutorial/advanced/index.html#choosing-a-solver)
 
-[![Build Status](https://travis-ci.org/ankane/scs.svg?branch=master)](https://travis-ci.org/ankane/scs) [![Build status](https://ci.appveyor.com/api/projects/status/wyn0cbgs0k5vg5tq/branch/master?svg=true)](https://ci.appveyor.com/project/ankane/scs/branch/master)
+[![Build Status](https://github.com/ankane/scs-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/scs-ruby/actions)
 
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'scs'
+gem "scs"
 ```
 
 If installation fails, you may need to install [dependencies](#dependencies).
@@ -39,16 +39,21 @@ Default values shown
 ```ruby
 solver.solve(data, cone, {
   normalize: true,            # heuristic data rescaling
-  scale: 1.0,                 # if normalized, rescales by this factor
-  rho_x: 1e-3,                # x equality constraint scaling
-  max_iters: 5000,            # maximum iterations to take
-  eps: 1e-5,                  # convergence tolerance
+  scale: 0.1,                 # if normalized, rescales by this factor
+  adaptive_scale: true,       # heuristically adapt dual scale through the solve
+  rho_x: 1e-6,                # x equality constraint scaling
+  max_iters: 1e5,             # maximum iterations to take
+  eps_abs: 1e-4,              # absolute feasibility tolerance
+  eps_rel: 1e-4,              # relative feasibility tolerance
+  eps_infeas: 1e-7,           # infeasibility tolerance
   alpha: 1.5,                 # relaxation parameter
-  cg_rate: 2.0,               # for indirect, tolerance goes down like (1/iter)^cg_rate
+  time_limit_secs: nil,       # time limit for solve run in seconds
   verbose: true,              # write out progress
   warm_start: false,          # warm start
   acceleration_lookback: 10,  # memory for acceleration
-  write_data_filename: nil    # filename to write data if set
+  acceleration_interval: 10,  # iterations to run Anderson acceleration
+  write_data_filename: nil,   # filename to write data if set
+  log_csv_filename: nil       # write csv logs of various quantities
 })
 ```
 
@@ -76,22 +81,22 @@ On Heroku, use the [heroku-apt-buildpack](https://github.com/heroku/heroku-build
 
 ## History
 
-View the [changelog](https://github.com/ankane/scs/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/scs-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/scs/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/scs/pulls)
+- [Report bugs](https://github.com/ankane/scs-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/scs-ruby/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
 To get started with development:
 
 ```sh
-git clone --recursive https://github.com/ankane/scs.git
-cd scs
+git clone --recursive https://github.com/ankane/scs-ruby.git
+cd scs-ruby
 bundle install
 bundle exec rake compile
 bundle exec rake test

data/lib/scs/ffi.rb

@@ -27,13 +27,6 @@ module SCS
 
         dlload File.expand_path("../../vendor/scs/out/#{lib_name}.#{ext}", __dir__)
 
-        extern "size_t scs_sizeof_int(void)"
-        extern "size_t scs_sizeof_float(void)"
-
-        # TODO support other sizes
-        raise Error, "Unsupported int size" if scs_sizeof_int != 4
-        raise Error, "Unsupported float size" if scs_sizeof_float != 8
-
         typealias "scs_float", "double"
         typealias "scs_int", "int"
 
@@ -41,14 +34,17 @@ module SCS
           "scs_int m",
           "scs_int n",
           "ScsMatrix *a",
+          "ScsMatrix *p",
           "scs_float *b",
           "scs_float *c",
-          "ScsSettings *stgs"
         ]
 
         m::Cone = struct [
-          "scs_int f",
+          "scs_int z",
           "scs_int l",
+          "scs_float *bu",
+          "scs_float *bl",
+          "scs_int *bsize",
           "scs_int *q",
           "scs_int qsize",
           "scs_int *s",
@@ -67,31 +63,46 @@ module SCS
 
         m::Info = struct [
           "scs_int iter",
-          "char status[32]",
+          "char status[128]",
+          "char lin_sys_solver[128]",
           "scs_int status_val",
+          "scs_int scale_updates",
           "scs_float pobj",
           "scs_float dobj",
           "scs_float res_pri",
           "scs_float res_dual",
+          "scs_float gap",
           "scs_float res_infeas",
-          "scs_float res_unbdd",
-          "scs_float rel_gap",
+          "scs_float res_unbdd_a",
+          "scs_float res_unbdd_p",
           "scs_float setup_time",
-          "scs_float solve_time"
+          "scs_float solve_time",
+          "scs_float scale",
+          "scs_float comp_slack",
+          "scs_int rejected_accel_steps",
+          "scs_int accepted_accel_steps",
+          "scs_float lin_sys_time",
+          "scs_float cone_time",
+          "scs_float accel_time"
         ]
 
         m::Settings = struct [
           "scs_int normalize",
           "scs_float scale",
+          "scs_int adaptive_scale",
           "scs_float rho_x",
           "scs_int max_iters",
-          "scs_float eps",
+          "scs_float eps_abs",
+          "scs_float eps_rel",
+          "scs_float eps_infeas",
           "scs_float alpha",
-          "scs_float cg_rate",
+          "scs_float time_limit_secs",
           "scs_int verbose",
           "scs_int warm_start",
           "scs_int acceleration_lookback",
-          "const char* write_data_filename"
+          "scs_int acceleration_interval",
+          "const char* write_data_filename",
+          "const char *log_csv_filename"
         ]
 
         m::Matrix = struct [
@@ -103,14 +114,14 @@ module SCS
         ]
 
         # scs.h
-        extern "ScsWork *scs_init(const ScsData *d, const ScsCone *k, ScsInfo *info)"
-        extern "scs_int scs_solve(ScsWork *w, const ScsData *d, const ScsCone *k, ScsSolution *sol, ScsInfo *info)"
+        extern "ScsWork *scs_init(const ScsData *d, const ScsCone *k, const ScsSettings *stgs)"
+        extern "scs_int scs_solve(ScsWork *w, ScsSolution *sol, ScsInfo *info)"
         extern "void scs_finish(ScsWork *w)"
-        extern "scs_int scs(const ScsData *d, const ScsCone *k, ScsSolution *sol, ScsInfo *info)"
+        extern "scs_int scs(const ScsData *d, const ScsCone *k, const ScsSettings *stgs, ScsSolution *sol, ScsInfo *info)"
         extern "const char *scs_version(void)"
 
         # utils.h
-        extern "void scs_set_default_settings(ScsData *d)"
+        extern "void scs_set_default_settings(ScsSettings *stgs)"
       end
     end
   end

data/lib/scs/solver.rb

@@ -6,13 +6,13 @@ module SCS
 
     def solve(data, cone, **settings)
       cdata = create_data(data)
-      set_settings(cdata, settings)
+      settings = create_settings(settings)
       ccone = create_cone(cone)
 
       solution = calloc(ffi::Solution.size) # alloc clear memory
       info = ffi::Info.malloc
 
-      ffi.scs(cdata, ccone, solution, info)
+      ffi.scs(cdata, ccone, settings, solution, info)
 
       solution = ffi::Solution.new(solution)
       x = read_float_array(solution.x, cdata.n)
@@ -26,15 +26,24 @@ module SCS
         iter: info.iter,
         status: read_string(info.status),
         status_val: info.status_val,
+        scale_updates: info.scale_updates,
         pobj: info.pobj,
         dobj: info.dobj,
         res_pri: info.res_pri,
         res_dual: info.res_dual,
+        gap: info.gap,
         res_infeas: info.res_infeas,
-        res_unbdd: info.res_unbdd,
-        rel_gap: info.rel_gap,
+        res_unbdd_a: info.res_unbdd_a,
+        res_unbdd_p: info.res_unbdd_p,
         setup_time: info.setup_time,
-        solve_time: info.solve_time
+        solve_time: info.solve_time,
+        scale: info.scale,
+        comp_slack: info.comp_slack,
+        rejected_accel_steps: info.rejected_accel_steps,
+        accepted_accel_steps: info.accepted_accel_steps,
+        lin_sys_time: info.lin_sys_time,
+        cone_time: info.cone_time,
+        accel_time: info.accel_time
       }
     end
 
@@ -114,15 +123,30 @@ module SCS
       cdata.m = m
       cdata.n = n
       cdata.a = csc_matrix(data[:a])
+
+      if data[:p]
+        raise ArgumentError, "Bad p shape" if shape(data[:p]) != [n, n]
+        cdata.p = csc_matrix(data[:p])
+      end
+
+      raise ArgumentError, "Bad b size" if data[:b].to_a.size != m
       cdata.b = float_array(data[:b])
+
+      raise ArgumentError, "Bad c size" if data[:c].to_a.size != n
       cdata.c = float_array(data[:c])
       cdata
     end
 
     def create_cone(cone)
       ccone = ffi::Cone.malloc
-      ccone.f = cone[:f].to_i
+      ccone.z = cone[:z].to_i
       ccone.l = cone[:l].to_i
+      ccone.bu = float_array(cone[:bu])
+      ccone.bl = float_array(cone[:bl])
+      if cone[:bu].to_a.size != cone[:bl].to_a.size
+        raise ArgumentError, "Expected bu and bl size to match"
+      end
+      ccone.bsize = cone[:bu].to_a.size
       ccone.q = int_array(cone[:q])
       ccone.qsize = cone[:q].to_a.size
       ccone.s = int_array(cone[:s])
@@ -134,10 +158,9 @@ module SCS
       ccone
     end
 
-    def set_settings(data, settings)
+    def create_settings(settings)
       set = ffi::Settings.malloc
-      data.stgs = set
-      ffi.scs_set_default_settings(data)
+      ffi.scs_set_default_settings(set)
 
       # hack for setting members with []=
       # safer than send("#{k}=", v)

data/lib/scs/version.rb

@@ -1,3 +1,3 @@
 module SCS
-  VERSION = "0.2.2"
+  VERSION = "0.3.2"
 end

data/vendor/scs/CITATION.cff

@@ -0,0 +1,39 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "O'Donoghue"
+  given-names: "Brendan"
+- family-names: "Chu"
+  given-names: "Eric"
+- family-names: "Parikh"
+  given-names: "Neal"
+- family-names: "Boyd"
+  given-names: "Stephen"
+title: "SCS: Spltting Conic Solver"
+version: 3.1.1
+date-released: 2021
+url: "https://github.com/cvxgrp/scs"
+
+# Original SCS paper:
+preferred-citation:
+  type: article
+  authors:
+  - family-names: "O'Donoghue"
+    given-names: "Brendan"
+  - family-names: "Chu"
+    given-names: "Eric"
+  - family-names: "Parikh"
+    given-names: "Neal"
+  - family-names: "Boyd"
+    given-names: "Stephen"
+  journal: "Journal of Optimization Theory and Applications"
+  month: 6
+  start: 1042  # Start pages
+  end: 1068  # End pages
+  title: "Conic Optimization via Operator Splitting and Homogeneous Self-Dual Embedding"
+  issue: 3
+  volume: 169
+  year: 2016
+  doi: 10.1007/s10957-016-0892-3
+  url: https://dx.doi.org/10.1007/s10957-016-0892-3
+