clp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6e2766ba9c5090563dd6534448cafcddb24affc2914cfe428671c1974ab7a07
+  data.tar.gz: 98d8951377b92b09c6df285e55117b7ac4d81c1836b54dcf9912b1ed059849de
+SHA512:
+  metadata.gz: dbe28bb36c4c55ed5d39d2f6be0c3a2302ff069662c03e3aff4b197a7a63db82cf1c7cac1b8e7ebb6ef9f6d5a840e9b7f964ff3fa8421b1d8b468d1d33eada48
+  data.tar.gz: 5379acb441756aaec7d2c12e3685203c992cb4f14430a75c382fb8bca0e4fd5556012af71ff80f9f2c4cbfa0c77bae29e98cbfc3718e7c8599a0262823a04d6a

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2022-04-05)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,244 @@
+Eclipse Public License - v 2.0
+
+THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
+LICENSE (“AGREEMENT”). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM
+CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+   “Contribution” means:
+
+      a) in the case of the initial Contributor, the initial content Distributed
+         under this Agreement, and
+      b) in the case of each subsequent Contributor:
+         i) changes to the Program, and
+         ii) additions to the Program;
+      where such changes and/or additions to the Program originate from and
+      are Distributed by that particular Contributor. A Contribution
+      “originates” from a Contributor if it was added to the Program by such
+      Contributor itself or anyone acting on such Contributor's behalf.
+      Contributions do not include changes or additions to the Program that
+      are not Modified Works. “Contributor” means any person or entity that
+      Distributes the Program.
+
+   “Licensed Patents” mean patent claims licensable by a Contributor which are
+   necessarily infringed by the use or sale of its Contribution alone or when
+   combined with the Program.
+
+   “Program” means the Contributions Distributed in accordance with this
+   Agreement.
+
+   “Recipient” means anyone who receives the Program under this Agreement or
+   any Secondary License (as applicable), including Contributors.
+
+   “Derivative Works” shall mean any work, whether in Source Code or other
+   form, that is based on (or derived from) the Program and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship.
+
+   “Modified Works” shall mean any work in Source Code or other form that
+   results from an addition to, deletion from, or modification of the contents
+   of the Program, including, for purposes of clarity any new file in Source
+   Code form that contains any contents of the Program. Modified Works shall
+   not include works that contain only declarations, interfaces, types,
+   classes, structures, or files of the Program solely in each case in order
+   to link to, bind by name, or subclass the Program or Modified Works
+   thereof.
+
+   “Distribute” means the acts of a) distributing or b) making available in
+   any manner that enables the transfer of a copy.
+
+   “Source Code” means the form of a Program preferred for making
+   modifications, including but not limited to software source code,
+   documentation source, and configuration files.
+
+   “Secondary License” means either the GNU General Public License, Version
+   2.0, or any later versions of that license, including any exceptions or
+   additional permissions as identified by the initial Contributor.
+
+2. GRANT OF RIGHTS
+
+   a) Subject to the terms of this Agreement, each Contributor hereby grants
+   Recipient a non-exclusive, worldwide, royalty-free copyright license to
+   reproduce, prepare Derivative Works of, publicly display, publicly perform,
+   Distribute and sublicense the Contribution of such Contributor, if any, and
+   such Derivative Works.
+
+   b) Subject to the terms of this Agreement, each Contributor hereby grants
+   Recipient a non-exclusive, worldwide, royalty-free patent license under
+   Licensed Patents to make, use, sell, offer to sell, import and otherwise
+   transfer the Contribution of such Contributor, if any, in Source Code or
+   other form. This patent license shall apply to the combination of the
+   Contribution and the Program if, at the time the Contribution is added by
+   the Contributor, such addition of the Contribution causes such combination
+   to be covered by the Licensed Patents. The patent license shall not apply
+   to any other combinations which include the Contribution. No hardware per
+   se is licensed hereunder.
+
+   c) Recipient understands that although each Contributor grants the licenses
+   to its Contributions set forth herein, no assurances are provided by any
+   Contributor that the Program does not infringe the patent or other
+   intellectual property rights of any other entity. Each Contributor
+   disclaims any liability to Recipient for claims brought by any other entity
+   based on infringement of intellectual property rights or otherwise. As a
+   condition to exercising the rights and licenses granted hereunder, each
+   Recipient hereby assumes sole responsibility to secure any other
+   intellectual property rights needed, if any. For example, if a third party
+   patent license is required to allow Recipient to Distribute the Program, it
+   is Recipient's responsibility to acquire that license before distributing
+   the Program.
+
+   d) Each Contributor represents that to its knowledge it has sufficient
+   copyright rights in its Contribution, if any, to grant the copyright
+   license set forth in this Agreement.
+
+   e) Notwithstanding the terms of any Secondary License, no Contributor makes
+   additional grants to any Recipient (other than those set forth in this
+   Agreement) as a result of such Recipient's receipt of the Program under the
+   terms of a Secondary License (if permitted under the terms of Section 3).
+
+3. REQUIREMENTS
+
+3.1 If a Contributor Distributes the Program in any form, then:
+
+   a) the Program must also be made available as Source Code, in accordance
+   with section 3.2, and the Contributor must accompany the Program with a
+   statement that the Source Code for the Program is available under this
+   Agreement, and informs Recipients how to obtain it in a reasonable manner
+   on or through a medium customarily used for software exchange; and
+
+   b) the Contributor may Distribute the Program under a license different
+   than this Agreement, provided that such license:
+
+      i) effectively disclaims on behalf of all other Contributors all
+      warranties and conditions, express and implied, including warranties or
+      conditions of title and non-infringement, and implied warranties or
+      conditions of merchantability and fitness for a particular purpose;
+
+      ii) effectively excludes on behalf of all other Contributors all
+      liability for damages, including direct, indirect, special, incidental
+      and consequential damages, such as lost profits;
+
+      iii) does not attempt to limit or alter the recipients' rights in the
+      Source Code under section 3.2; and
+
+      iv) requires any subsequent distribution of the Program by any party to
+      be under a license that satisfies the requirements of this section 3.
+
+3.2 When the Program is Distributed as Source Code:
+
+    a) it must be made available under this Agreement, or if the Program (i)
+    is combined with other material in a separate file or files made available
+    under a Secondary License, and (ii) the initial Contributor attached to
+    the Source Code the notice described in Exhibit A of this Agreement, then
+    the Program may be made available under the terms of such Secondary
+    Licenses, and
+
+    b) a copy of this Agreement must be included with each copy of the
+    Program.
+
+3.3 Contributors may not remove or alter any copyright, patent, trademark,
+attribution notices, disclaimers of warranty, or limitations of liability
+(‘notices’) contained within the Program from any copy of the Program which
+they Distribute, provided that Contributors may add their own appropriate
+notices.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain responsibilities with
+respect to end users, business partners and the like. While this license is
+intended to facilitate the commercial use of the Program, the Contributor who
+includes the Program in a commercial product offering should do so in a manner
+which does not create potential liability for other Contributors. Therefore,
+if a Contributor includes the Program in a commercial product offering, such
+Contributor (“Commercial Contributor”) hereby agrees to defend and indemnify
+every other Contributor (“Indemnified Contributor”) against any losses,
+damages and costs (collectively “Losses”) arising from claims, lawsuits and
+other legal actions brought by a third party against the Indemnified
+Contributor to the extent caused by the acts or omissions of such Commercial
+Contributor in connection with its distribution of the Program in a commercial
+product offering. The obligations in this section do not apply to any claims
+or Losses relating to any actual or alleged intellectual property
+infringement. In order to qualify, an Indemnified Contributor must: a)
+promptly notify the Commercial Contributor in writing of such claim, and b)
+allow the Commercial Contributor to control, and cooperate with the Commercial
+Contributor in, the defense and any related settlement negotiations. The
+Indemnified Contributor may participate in any such claim at its own expense.
+
+For example, a Contributor might include the Program in a commercial product
+offering, Product X. That Contributor is then a Commercial Contributor. If
+that Commercial Contributor then makes performance claims, or offers
+warranties related to Product X, those performance claims and warranties are
+such Commercial Contributor's responsibility alone. Under this section, the
+Commercial Contributor would have to defend claims against the other
+Contributors related to those performance claims and warranties, and if a
+court requires any other Contributor to pay any damages as a result, the
+Commercial Contributor must pay those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED
+BY APPLICABLE LAW, THE PROGRAM IS PROVIDED 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. Each Recipient is solely
+responsible for determining the appropriateness of using and distributing the
+Program and assumes all risks associated with its exercise of rights under
+this Agreement, including but not limited to the risks and costs of program
+errors, compliance with applicable laws, damage to or loss of data, programs
+or equipment, and unavailability or interruption of operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED
+BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY
+LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), 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
+OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
+HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of the
+remainder of the terms of this Agreement, and without further action by the
+parties hereto, such provision shall be reformed to the minimum extent
+necessary to make such provision valid and enforceable.
+
+If Recipient institutes patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Program itself
+(excluding combinations of the Program with other software or hardware)
+infringes such Recipient's patent(s), then such Recipient's rights granted
+under Section 2(b) shall terminate as of the date such litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it fails to
+comply with any of the material terms or conditions of this Agreement and does
+not cure such failure in a reasonable period of time after becoming aware of
+such noncompliance. If all Recipient's rights under this Agreement terminate,
+Recipient agrees to cease use and distribution of the Program as soon as
+reasonably practicable. However, Recipient's obligations under this Agreement
+and any licenses granted by Recipient relating to the Program shall continue
+and survive.
+
+Everyone is permitted to copy and distribute copies of this Agreement, but in
+order to avoid inconsistency the Agreement is copyrighted and may only be
+modified in the following manner. The Agreement Steward reserves the right to
+publish new versions (including revisions) of this Agreement from time to
+time. No one other than the Agreement Steward has the right to modify this
+Agreement. The Eclipse Foundation is the initial Agreement Steward. The
+Eclipse Foundation may assign the responsibility to serve as the Agreement
+Steward to a suitable separate entity. Each new version of the Agreement will
+be given a distinguishing version number. The Program (including
+Contributions) may always be Distributed subject to the version of the
+Agreement under which it was received. In addition, after a new version of the
+Agreement is published, Contributor may elect to Distribute the Program
+(including its Contributions) under the new version.
+
+Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives
+no rights or licenses to the intellectual property of any Contributor under
+this Agreement, whether expressly, by implication, estoppel or otherwise. All
+rights in the Program not expressly granted under this Agreement are reserved.
+Nothing in this Agreement is intended to be enforceable by any entity that is
+not a Contributor or Recipient. No third-party beneficiary rights are created
+under this Agreement.

data/README.md

@@ -0,0 +1,86 @@
+# Clp Ruby
+
+[Clp](https://github.com/coin-or/Clp) - linear programming solver - for Ruby
+
+[![Build Status](https://github.com/ankane/clp-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/clp-ruby/actions)
+
+## Installation
+
+First, install Clp. For Homebrew, use:
+
+```sh
+brew install clp
+```
+
+And for Ubuntu, use:
+
+```sh
+sudo apt-get install coinor-libclp1
+```
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "clp"
+```
+
+## Getting Started
+
+*The API is fairly low-level at the moment*
+
+Load a problem
+
+```ruby
+model =
+  Clp.load_problem(
+    sense: :minimize,
+    start: [0, 3, 6],
+    index: [0, 1, 2, 0, 1, 2],
+    value: [2, 3, 2, 2, 4, 1],
+    col_lower: [0, 0],
+    col_upper: [1e30, 1e30],
+    obj: [8, 10],
+    row_lower: [7, 12, 6],
+    row_upper: [1e30, 1e30, 1e30]
+  )
+```
+
+Solve
+
+```ruby
+model.solve
+```
+
+Write the problem to an MPS file
+
+```ruby
+model.write_mps("hello.mps")
+```
+
+Read a problem from an MPS file
+
+```ruby
+model = Clp.read_mps("hello.mps")
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/clp-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/clp-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/clp-ruby/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/clp-ruby.git
+cd clp-ruby
+bundle install
+bundle exec rake test
+```

data/lib/clp/ffi.rb

@@ -0,0 +1,62 @@
+module Clp
+  module FFI
+    extend Fiddle::Importer
+
+    libs = Array(Clp.ffi_lib).dup
+    begin
+      dlload Fiddle.dlopen(libs.shift)
+    rescue Fiddle::DLError => e
+      retry if libs.any?
+      raise e
+    end
+
+    # https://github.com/coin-or/Clp/blob/master/src/Clp_C_Interface.h
+
+    OBJ_SENSE = {
+      minimize: 1,
+      maximize: -1
+    }
+
+    STATUS = [:optimal, :primal_infeasible, :dual_infeasible, :stopped, :error]
+
+    typealias "CoinBigIndex", "int"
+
+    # version info
+    extern "char * Clp_Version(void)"
+
+    # constructors and destructors
+    extern "Clp_Simplex * Clp_newModel(void)"
+    extern "void Clp_deleteModel(Clp_Simplex *model)"
+    extern "Clp_Solve * ClpSolve_new()"
+    extern "void ClpSolve_delete(Clp_Solve *solve)"
+
+    # load models
+    extern "void Clp_loadProblem(Clp_Simplex *model, int numcols, int numrows, CoinBigIndex *start, int *index, double *value, double *collb, double *colub, double *obj, double *rowlb, double *rowub)"
+    extern "int Clp_readMps(Clp_Simplex *model, char *filename, int keepNames, int ignoreErrors)"
+    extern "int Clp_writeMps(Clp_Simplex *model, char *filename, int formatType, int numberAcross, double objSense)"
+
+    # getters and setters
+    extern "int Clp_numberRows(Clp_Simplex *model)"
+    extern "int Clp_numberColumns(Clp_Simplex *model)"
+    extern "double Clp_objectiveOffset(Clp_Simplex *model)"
+    extern "void Clp_setObjectiveOffset(Clp_Simplex *model, double value)"
+    extern "int Clp_status(Clp_Simplex *model)"
+    extern "double Clp_getObjSense(Clp_Simplex *model)"
+    extern "void Clp_setObjSense(Clp_Simplex *model, double objsen)"
+    extern "double * Clp_primalRowSolution(Clp_Simplex *model)"
+    extern "double * Clp_primalColumnSolution(Clp_Simplex *model)"
+    extern "double * Clp_dualRowSolution(Clp_Simplex *model)"
+    extern "double * Clp_dualColumnSolution(Clp_Simplex *model)"
+    extern "double * Clp_objective(Clp_Simplex *model)"
+    extern "CoinBigIndex Clp_getNumElements(Clp_Simplex *model)"
+    extern "CoinBigIndex * Clp_getVectorStarts(Clp_Simplex *model)"
+    extern "int * Clp_getIndices(Clp_Simplex *model)"
+    extern "int * Clp_getVectorLengths(Clp_Simplex *model)"
+    extern "double * Clp_getElements(Clp_Simplex *model)"
+    extern "double Clp_objectiveValue(Clp_Simplex *model)"
+    extern "void Clp_setLogLevel(Clp_Simplex *model, int value)"
+
+    # solve
+    extern "int Clp_initialSolve(Clp_Simplex *model)"
+  end
+end

data/lib/clp/model.rb

@@ -0,0 +1,88 @@
+module Clp
+  class Model
+    def initialize
+      @model = FFI.Clp_newModel
+      ObjectSpace.define_finalizer(self, self.class.finalize(@model))
+
+      FFI.Clp_setLogLevel(model, 0)
+    end
+
+    def load_problem(sense:, start:, index:, value:, col_lower:, col_upper:, obj:, row_lower:, row_upper:, offset: 0)
+      start_size = start.size
+      index_size = index.size
+      num_cols = col_lower.size
+      num_rows = row_lower.size
+
+      FFI.Clp_loadProblem(
+        model, num_cols, num_rows,
+        big_index_array(start, start_size), int_array(index, index_size), double_array(value, index_size),
+        double_array(col_lower, num_cols), double_array(col_upper, num_cols), double_array(obj, num_cols),
+        double_array(row_lower, num_rows), double_array(row_upper, num_rows)
+      )
+      FFI.Clp_setObjSense(model, FFI::OBJ_SENSE.fetch(sense))
+      FFI.Clp_setObjectiveOffset(model, offset)
+    end
+
+    def read_mps(filename)
+      check_status FFI.Clp_readMps(model, filename, 0, 0)
+    end
+
+    def write_mps(filename)
+      check_status FFI.Clp_writeMps(model, filename, 0, 1, 0)
+    end
+
+    def solve
+      check_status FFI.Clp_initialSolve(model)
+
+      num_rows = FFI.Clp_numberRows(model)
+      num_cols = FFI.Clp_numberColumns(model)
+
+      {
+        status: FFI::STATUS[FFI.Clp_status(model)],
+        objective: FFI.Clp_objectiveValue(model),
+        primal_row: read_double_array(FFI.Clp_primalRowSolution(model), num_rows),
+        primal_col: read_double_array(FFI.Clp_primalColumnSolution(model), num_cols),
+        dual_row: read_double_array(FFI.Clp_dualRowSolution(model), num_rows),
+        dual_col: read_double_array(FFI.Clp_dualColumnSolution(model), num_cols)
+      }
+    end
+
+    def self.finalize(model)
+      # must use proc instead of stabby lambda
+      proc { FFI.Clp_deleteModel(model) }
+    end
+
+    private
+
+    def model
+      @model
+    end
+
+    def check_status(status)
+      if status != 0
+        raise Error, "Bad status"
+      end
+    end
+
+    def double_array(value, size)
+      base_array(value, size, "d")
+    end
+
+    def int_array(value, size)
+      base_array(value, size, "i!")
+    end
+    alias_method :big_index_array, :int_array
+
+    def base_array(value, size, format)
+      if value.size != size
+        # TODO add variable name to message
+        raise ArgumentError, "wrong size (given #{value.size}, expected #{size})"
+      end
+      Fiddle::Pointer[value.pack("#{format}#{size}")]
+    end
+
+    def read_double_array(ptr, size)
+      ptr[0, size * Fiddle::SIZEOF_DOUBLE].unpack("d#{size}")
+    end
+  end
+end

data/lib/clp/version.rb

@@ -0,0 +1,3 @@
+module Clp
+  VERSION = "0.1.0"
+end

data/lib/clp.rb

@@ -0,0 +1,42 @@
+# stdlib
+require "fiddle/import"
+
+# modules
+require "clp/model"
+require "clp/version"
+
+module Clp
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :ffi_lib
+  end
+  lib_name =
+    if Gem.win_platform?
+      "clp.dll"
+    elsif RbConfig::CONFIG["host_os"] =~ /darwin/i
+      "libclp.dylib"
+    else
+      "libclp.so"
+    end
+  self.ffi_lib = [lib_name]
+
+  # friendlier error message
+  autoload :FFI, "clp/ffi"
+
+  def self.lib_version
+    FFI.Clp_Version.to_s
+  end
+
+  def self.read_mps(filename)
+    model = Model.new
+    model.read_mps(filename)
+    model
+  end
+
+  def self.load_problem(**options)
+    model = Model.new
+    model.load_problem(**options)
+    model
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: clp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-06 00:00:00.000000000 Z
+dependencies: []
+description:
+email: andrew@ankane.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/clp.rb
+- lib/clp/ffi.rb
+- lib/clp/model.rb
+- lib/clp/version.rb
+homepage: https://github.com/ankane/clp-ruby
+licenses:
+- EPL-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Linear programming solver for Ruby
+test_files: []