quicopt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3149e149b55706102ba346c10b6768e8cfbab47977aaf6ca979cb388c4ee1b9
+  data.tar.gz: 88307afbd6a77015173c066bf0f1162010f041c72a5666549e9e3be013dda446
+SHA512:
+  metadata.gz: 6c4844cbe4e9b8d1577125bc9671ffb0a6a6993d2d18570579d82ef3ca412427bcd854a7e925e75f0ca85473277e895a2c2b9b08487c3cdfe7b7a5af20bb0226
+  data.tar.gz: d78fc525172e40e19a47b4eec7811b34ba843d9a43a21ecac3609f7a366b4f3aa65cecb660891587fea5a02a69362a48ce6e9f35b356bae1cddcdabcbc0ee12a

data/.yardopts

@@ -0,0 +1,9 @@
+--readme README.md
+--output-dir doc
+--template-path templates
+--no-private
+--hide-void-return
+--exclude lib/quicopt/modeler
+lib/**/*.rb
+-
+LICENSE

data/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.
+
+   (c) 2026 Tim Bode, PGI-12, Forschungszentrum Jülich
+
+   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/README.md

@@ -0,0 +1,205 @@
+# quicopt
+
+A Ruby client for the Quicopt optimization service.
+
+It does exactly three things: author an optimization model in a small native Ruby
+DSL, encode it to the versioned Quicopt wire IR, and send it to the service. It is
+the Ruby peer of the Python and Julia clients — the same wire contract, the same
+results.
+
+There is no local solver here. The service does the solving.
+
+## Install
+
+```ruby
+gem "quicopt"
+```
+
+or
+
+```sh
+gem install quicopt
+```
+
+Ruby 3.2 or newer. The only runtime dependency is `google-protobuf`; the transport
+is stdlib `net/http`.
+
+## Quick start
+
+```ruby
+require "quicopt"
+
+m = Quicopt::Model.new
+x = m.int_var(0, 4, "x")
+y = m.bin_var("y")
+z = m.num_var(0, 10, "z")
+
+m.maximize(3 * x + 2 * y + z)
+m.add(x + y <= 5)
+
+result = Quicopt::Client.new.solve(m)
+puts result.display
+```
+
+`result.display` is rendered by the service and ready to print — the same summary
+for every kind of model. The structured fields are there too:
+
+```ruby
+result.status              # "optimal", "heuristic", …
+result.objective           # Float, or nil where the outcome leaves it undefined
+result.feasible            # true / false / nil
+result.solution            # {"x" => 4.0, "y" => 1.0, "z" => 10.0}
+result.solve_time_seconds
+```
+
+## The model
+
+### Variables
+
+```ruby
+m.num_var(0, 10, "z")     # continuous
+m.int_var(0, 4, "x")      # integer
+m.bin_var("y")            # binary
+m.num_var(nil, nil, "w")  # free: unbounded in both directions
+```
+
+The name is optional and generated when omitted, but solutions come back keyed by
+it, so naming your variables is worth it. `start:` sets the initial point; it
+defaults to 0 clamped into the bounds.
+
+Integer variables with bounds of exactly `[0, 1]` are declared binary — the same
+normalisation the other clients apply, so one model reaches the service as one
+program whichever language authored it.
+
+### Expressions
+
+`+`, `-`, `*`, `/` and `**` build expressions, and a number may sit on either
+side:
+
+```ruby
+3 * x + 2 * y - 4
+(x + 1) * (y + 2)      # quadratic
+z**2                   # quadratic
+x / 2                  # division by a constant
+```
+
+Expressions are normalised as they are built — a constant plus linear terms plus
+quadratic terms — so `x * y` and `y * x` are the same term, and `x - x` is zero.
+
+Only linear and quadratic expressions exist. Anything beyond that raises at the
+point you write it, rather than being silently dropped or approximated:
+
+```ruby
+x * y * z    # Quicopt::UnsupportedExpression: exceeds the quadratic subset
+x / y        # Quicopt::UnsupportedExpression: division by a variable
+x**3         # Quicopt::UnsupportedExpression
+```
+
+### Constraints
+
+`<=`, `>=` and `==` build constraint rows, not booleans:
+
+```ruby
+m.add(x + y <= 5)
+m.add(2 * x - z >= -1)
+m.add(x + z == 3)
+```
+
+Two consequences of that, both deliberate:
+
+- `x == 5` is a row. Comparing a variable to something that could never be part
+  of an expression (`x == nil`) still answers `false`, and variables remain
+  usable as Hash and Set keys, but do not expect `==` to test equality.
+- `!=` has no wire form and raises rather than quietly answering `false`.
+- A number on the left works (`5 <= x`), because Ruby hands the comparison back
+  to the expression. `5 == x`, however, is Ruby's own `Integer#==` and is just
+  `false` — write `x == 5`.
+
+Chained comparisons (`1 <= x <= 5`) are not a thing in Ruby. Add two rows.
+
+## Working with the wire bytes
+
+The encoded program is not hidden. Inspect it, cache it, or route it yourself:
+
+```ruby
+bytes   = m.encode          # binary protobuf, ready to POST
+program = m.to_program      # the structured wire IR
+Quicopt.decode(bytes)       # back to a program
+
+Quicopt::Client.new.solve(bytes)   # solve pre-encoded bytes directly
+```
+
+The wire schema is `proto/quicopt/modeler/v1/program.proto`, vendored in this
+repository; `gen/gen.sh` regenerates the codec from it.
+
+Note that the generated codec omits zero-valued scalars and does not canonicalize
+field order, so two encodings of the same model are *decode-equivalent* rather
+than byte-identical. Compare decoded programs, never hex.
+
+## The client
+
+```ruby
+client = Quicopt::Client.new                       # the public free tier
+client = Quicopt::Client.new("http://localhost:8137")
+client = Quicopt::Client.new(url, "my-api-key", timeout: 120)
+```
+
+**Keys.** The first call without a key mints one, cached at
+`$XDG_CACHE_HOME/quicopt/free_key` (`~/.cache/…` by default) and replayed as a
+bearer token on every later call — including from later runs, so you keep one key
+without doing anything. A key you passed in is used as-is, never cached and never
+overwritten; `Quicopt::Client.new(url, cache: false)` keeps the minted key in
+memory only.
+
+Where the home directory does not survive the run (CI, containers), the cache is
+wiped between sessions and each run mints a new key. Set `QUICOPT_KEY_PATH` to a
+durable location — or `Client.new(url, key_path: …)` — to keep one key across
+sessions.
+
+**Per-project tagging.** `solve(model, project: "atlas")` tags the call so usage on
+one key can be attributed per project. It rides the query string and is never
+baked into the model.
+
+**Large models.** `solve(model, gzip: true)` compresses the request body.
+
+**Asynchronous solving.** Use this for the first call against a server that may
+still be warming up, where a blocking call could time out:
+
+```ruby
+job = client.submit(m)
+job.status                       # {"status" => "running", …}
+result = job.result              # polls until done
+job.log                          # the framed log view
+job.delete                       # remove the job and its stored data
+```
+
+**Errors.** A non-2xx response raises `Quicopt::QuicoptError`, which carries a
+stable machine-readable `reason` — match on that, not on the message:
+
+```ruby
+begin
+  client.solve(m)
+rescue Quicopt::QuicoptError => e
+  puts e.display                 # ready-to-print, server-rendered
+  retry if e.reason == "queue_busy"
+  raise
+end
+```
+
+Everything this gem raises descends from `Quicopt::Error`.
+
+## Development
+
+```sh
+bundle install
+bundle exec rake        # run the tests
+gen/gen.sh              # regenerate the codec after a schema change
+```
+
+The client tests run against a real local HTTP server rather than a stubbed
+`Net::HTTP`, so the transport — headers, query encoding, gzip framing, key
+capture, the error path — is covered end to end.
+
+## Licence
+
+Apache-2.0. See [LICENSE](LICENSE).